Cookie Improvement

README.md

@@ -72,7 +72,7 @@ __More Examples__
 - [Body Types](https://github.com/rustasync/tide/blob/master/examples/body_types.rs)
 - [Multipart Form](https://github.com/rustasync/tide/tree/master/examples/multipart-form/main.rs)
 - [Catch All](https://github.com/rustasync/tide/tree/master/examples/catch_all.rs)
-- [Cookie Extractor](https://github.com/rustasync/tide/tree/master/examples/cookie_extractor.rs)
+- [Cookies](https://github.com/rustasync/tide/tree/master/examples/cookies.rs)
 - [Default Headers](https://github.com/rustasync/tide/tree/master/examples/default_headers.rs)
 - [GraphQL](https://github.com/rustasync/tide/tree/master/examples/graphql.rs)
 

src/cookies.rs

@@ -32,7 +32,12 @@ impl CookieData {
 pub trait CookiesExt {
     /// returns a `Cookie` by name of the cookie
     fn get_cookie(&mut self, name: &str) -> Result<Option<Cookie<'static>>, StringError>;
+
+    /// Add cookie to the cookie jar
     fn set_cookie(&mut self, cookie: Cookie<'static>) -> Result<(), StringError>;
+
+    /// Removes the cookie. This instructs the `CookiesMiddleware` to send a cookie with empty value
+    /// in the response.
     fn remove_cookie(&mut self, cookie: Cookie<'static>) -> Result<(), StringError>;
 }
 

src/middleware/cookies.rs

@@ -7,6 +7,11 @@ use crate::{
     Context, Response,
 };
 
+/// `CookiesMiddleware middleware is required for `CookiesExt` implementation on `Context` to work.
+/// This middleware parses cookies from request and caches them in the extension. Once the request
+/// is processed by endpoints and other middlewares, all the added and removed cookies are set on
+/// on the respone. You will need to add this middle before any other middlewares that might need to
+/// access Cookies.
 #[derive(Clone, Default)]
 pub struct CookiesMiddleware {}
 
@@ -38,7 +43,7 @@ impl<Data: Send + Sync + 'static> Middleware<Data> for CookiesMiddleware {
                 if let Ok(val) = hv {
                     headers.append(http::header::SET_COOKIE, val);
                 } else {
-                    //TODO Log error here
+                    // It would be useful to log this error here.
                     return http::Response::builder()
                         .status(http::status::StatusCode::INTERNAL_SERVER_ERROR)
                         .header("Content-Type", "text/plain; charset=utf-8")