chore: improve code example

Author: joseluisq

Cargo.toml

@@ -27,5 +27,5 @@ hyper = { version = "0.14", default-features = false, features = ["server", "tcp
 anyhow = "1.0"
 
 [dev-dependencies]
-# hyper = { version = "0.14", features = ["tcp", "server", "http1"] }
+hyper = { version = "0.14", features = ["tcp", "server", "http1"] }
 tokio = { version = "1", features = ["rt-multi-thread", "macros"], default-features = false }

README.md

@@ -1,4 +1,4 @@
-# Hyper Middleware
+# Hyper Middleware (WIP)
 
 > A compact middleware and handler system for [Hyper](https://github.com/hyperium/hyper) `0.14.x`.
 
@@ -10,12 +10,12 @@
 
 ## Example
 
-[src/bin/server.rs](src/bin/server.rs)
+[examples/server.rs](examples/server.rs)
 
 ```rust
 #![deny(warnings)]
 
-use hyper::{Server, StatusCode};
+use hyper::{header, Server, StatusCode};
 use std::{net::SocketAddr, path::PathBuf};
 
 use hyper_middleware::{
@@ -33,10 +33,10 @@ struct Application {
 
 impl Handler for Application {
     fn handle(&self, req: &mut Request) -> Result<Response> {
-        // Access Hyper incoming Request
+        // Access the Hyper incoming Request
         println!("URI Path: {}", req.uri().path());
 
-        // Access custom app options
+        // Access the custom app options
         println!("Config Root: {}", self.opts.root.display());
 
         // Access the Remote Address
@@ -45,16 +45,20 @@ impl Handler for Application {
             req.extensions().get::<SocketAddr>().unwrap()
         );
 
-        // Send a response back to the middlewares chain
+        // Create an Hyper Response and send it back to the middlewares chain
         Ok(Response::builder().body(Body::from("¡Hola!")).unwrap())
     }
 }
 
 struct FirstMiddleware {}
 
 impl BeforeMiddleware for FirstMiddleware {
-    fn before(&self, _: &mut Request) -> Result<()> {
+    fn before(&self, req: &mut Request) -> Result<()> {
         println!("First Middleware called!");
+
+        // Access the Hyper incoming Request
+        println!("URI Path: {}", req.uri().path());
+
         Ok(())
     }
 
@@ -66,8 +70,16 @@ impl BeforeMiddleware for FirstMiddleware {
 struct SecondMiddleware {}
 
 impl AfterMiddleware for SecondMiddleware {
-    fn after(&self, _: &mut Request, res: Response) -> Result<Response> {
+    fn after(&self, _: &mut Request, mut res: Response) -> Result<Response> {
         println!("Second Middleware called!");
+
+        // Mutate the Hyper Response at convenience
+        // and send it back to other middlewares on the chain
+        res.headers_mut().insert(
+            header::CONTENT_TYPE,
+            "text/html; charset=utf-8".parse().unwrap(),
+        );
+
         Ok(res)
     }
 
@@ -93,7 +105,7 @@ async fn main() -> Result {
     handler.link_before(FirstMiddleware {});
     handler.link_after(SecondMiddleware {});
 
-    // 3. Create a Hyper service and set the current handler with its middlewares
+    // 3. Create an Hyper service and set the current handler with its middlewares
     let service = Service::new(handler);
 
     // 4. Finally just run server using the service already created
@@ -108,6 +120,12 @@ async fn main() -> Result {
 }
 ```
 
+To run the example just type:
+
+```
+cargo run --example server
+```
+
 ## Contributions
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in current work by you, as defined in the Apache-2.0 license, shall be dual licensed as described below, without any additional terms or conditions.

examples/server.rs

@@ -3,7 +3,7 @@
 #![deny(rust_2018_idioms)]
 #![deny(dead_code)]
 
-use hyper::{Server, StatusCode};
+use hyper::{header, Server, StatusCode};
 use std::{net::SocketAddr, path::PathBuf};
 
 use hyper_middleware::{
@@ -21,10 +21,10 @@ struct Application {
 
 impl Handler for Application {
     fn handle(&self, req: &mut Request) -> Result<Response> {
-        // Access Hyper incoming Request
+        // Access the Hyper incoming Request
         println!("URI Path: {}", req.uri().path());
 
-        // Access custom app options
+        // Access the custom app options
         println!("Config Root: {}", self.opts.root.display());
 
         // Access the Remote Address
@@ -33,16 +33,20 @@ impl Handler for Application {
             req.extensions().get::<SocketAddr>().unwrap()
         );
 
-        // Send a response back to the middlewares chain
+        // Create an Hyper Response and send it back to the middlewares chain
         Ok(Response::builder().body(Body::from("¡Hola!")).unwrap())
     }
 }
 
 struct FirstMiddleware {}
 
 impl BeforeMiddleware for FirstMiddleware {
-    fn before(&self, _: &mut Request) -> Result<()> {
+    fn before(&self, req: &mut Request) -> Result<()> {
         println!("First Middleware called!");
+
+        // Access the Hyper incoming Request
+        println!("URI Path: {}", req.uri().path());
+
         Ok(())
     }
 
@@ -54,8 +58,16 @@ impl BeforeMiddleware for FirstMiddleware {
 struct SecondMiddleware {}
 
 impl AfterMiddleware for SecondMiddleware {
-    fn after(&self, _: &mut Request, res: Response) -> Result<Response> {
+    fn after(&self, _: &mut Request, mut res: Response) -> Result<Response> {
         println!("Second Middleware called!");
+
+        // Mutate the Hyper Response at convenience
+        // and send it back to other middlewares on the chain
+        res.headers_mut().insert(
+            header::CONTENT_TYPE,
+            "text/html; charset=utf-8".parse().unwrap(),
+        );
+
         Ok(res)
     }
 
@@ -81,7 +93,7 @@ async fn main() -> Result {
     handler.link_before(FirstMiddleware {});
     handler.link_after(SecondMiddleware {});
 
-    // 3. Create a Hyper service and set the current handler with its middlewares
+    // 3. Create an Hyper service and set the current handler with its middlewares
     let service = Service::new(handler);
 
     // 4. Finally just run server using the service already created

src/lib.rs

@@ -1,4 +1,4 @@
-#![deny(missing_docs)]
+// TODO: #![deny(missing_docs)]
 
 //! # hyper_middleware
 //!