From d0fed9f0784119f329394032af38aa18c77c3577 Mon Sep 17 00:00:00 2001 From: Sven-Hendrik Haase Date: Wed, 11 Sep 2019 16:49:00 +0200 Subject: [PATCH] Add better README for middleware example --- middleware/README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/middleware/README.md b/middleware/README.md index 9c901cb6..401b9fd9 100644 --- a/middleware/README.md +++ b/middleware/README.md @@ -1,4 +1,8 @@ -## Middleware example +# middleware examples + +This example showcases a bunch of different uses of middlewares. See also the [Middleware guide](https://actix.rs/docs/middleware/).. + +## Usage ```bash cd middleware @@ -8,3 +12,18 @@ cargo run Look in `src/main.rs` and comment the different middlewares in/out to see how they function. + +## Middlewares + +### redirect::CheckLogin + +A middleware implementing a request guard which sketches a rough approximation of what a login could look like. + +### read_body::Logging + +A middleware demonstrating how to read out the incoming request body. + +### simple::SayHi + +A minimal middleware demonstrating the sequence of operations in an actix middleware. +There is a second version of the same middleware using `wrap_fn` which shows how easily a middleware can be implemented in actix.