update micro_http documentation

Signed-off-by: George Pisaltu <gpl@amazon.com>

Author: georgepisaltu

micro_http/src/connection.rs

@@ -71,6 +71,11 @@ impl<T: Read + Write> HttpConnection<T> {
     /// Tries to read new bytes from the stream and automatically update the request.
     /// Meant to be used only with non-blocking streams and an `EPOLL` structure.
     /// Should be called whenever an `EPOLLIN` event is signaled.
+    ///
+    /// # Errors
+    /// `StreamError` is returned when an IO operation fails.
+    /// `ConnectionClosed` is returned when a client prematurely closes the connection.
+    /// `ParseError` is returned when a parsing operation fails.
     pub fn try_read(&mut self) -> Result<(), ConnectionError> {
         // Read some bytes from the stream, which will be appended to what is already
         // present in the buffer from a previous call of `try_read`. There are already
@@ -293,6 +298,12 @@ impl<T: Read + Write> HttpConnection<T> {
     /// Tries to write the first available response to the provided stream.
     /// Meant to be used only with non-blocking streams and an `EPOLL` structure.
     /// Should be called whenever an `EPOLLOUT` event is signaled.
+    ///
+    /// # Errors
+    /// `StreamError` is returned when an IO operation fails.
+    /// `ConnectionClosed` is returned when trying to write on a closed connection.
+    /// `InvalidWrite` is returned when trying to write on a connection with an
+    /// empty outgoing buffer.
     pub fn try_write(&mut self) -> Result<(), ConnectionError> {
         if self.response_buffer.is_none() {
             if let Some(response) = self.response_queue.pop_front() {
@@ -357,10 +368,16 @@ impl<T: Read + Write> HttpConnection<T> {
         self.read_cursor = end_cursor - line_start_index;
     }
 
-    /// Returns the first parsed request in the queue.
+    /// Returns the first parsed request in the queue or `None` if the queue
+    /// is empty.
     pub fn pop_parsed_request(&mut self) -> Option<Request> {
         self.parsed_requests.pop_front()
     }
+
+    /// Returns `true` if there are bytes waiting to be written into the stream.
+    pub fn pending_write(&self) -> bool {
+        self.response_buffer.is_some() || !self.response_queue.is_empty()
+    }
 }
 
 #[cfg(test)]

micro_http/src/lib.rs

@@ -56,11 +56,12 @@
 //! ## Example for creating an HTTP Response
 //! ```
 //! extern crate micro_http;
-//! use micro_http::{Body, Response, StatusCode, Version};
+//! use micro_http::{Body, Response, StatusCode, Version, MediaType};
 //!
 //! let mut response = Response::new(Version::Http10, StatusCode::OK);
 //! let body = String::from("This is a test");
 //! response.set_body(Body::new(body.clone()));
+//! response.set_content_type(MediaType::PlainText);
 //!
 //! assert!(response.status() == StatusCode::OK);
 //! assert_eq!(response.body().unwrap(), Body::new(body));

micro_http/src/server.rs

@@ -32,7 +32,7 @@ pub struct ServerRequest {
 }
 
 impl ServerRequest {
-    /// Creates a new `RequestWithID` object from an existing `Request`,
+    /// Creates a new `ServerRequest` object from an existing `Request`,
     /// adding an identification token.
     pub fn new(request: Request, id: u64) -> Self {
         ServerRequest { request, id }