Merge pull request #72 from yoshuawuyts/docs-polish

TypeMap polish

Author: yoshuawuyts

Cargo.toml

@@ -16,16 +16,18 @@ default = []
 hyperium_http = ["http"]
 
 [dependencies]
-async-std = { version = "1.4.0", features = ["unstable"] }
+anyhow = "1.0.26"
 cookie = "0.12.0"
 infer = "0.1.2"
+omnom = "2.1.1"
 pin-project-lite = "0.1.0"
 url = "2.1.0"
-omnom = "2.1.1"
+
+# Note(yoshuawuyts): used for async_std's `channel` only; use "core" once possible.
+async-std = { version = "1.4.0", features = ["unstable"] }
 
 # features: hyperium/http
 http = { version = "0.2.0", optional = true }
-anyhow = "1.0.26"
 
 [dev-dependencies]
 http = "0.2.0"

src/request.rs

@@ -35,7 +35,7 @@ pin_project_lite::pin_project! {
         receiver: sync::Receiver<crate::Result<Trailers>>,
         #[pin]
         body: Body,
-        local_state: TypeMap,
+        local: TypeMap,
     }
 }
 
@@ -51,7 +51,7 @@ impl Request {
             body: Body::empty(),
             sender: Some(sender),
             receiver,
-            local_state: TypeMap::new(),
+            local: TypeMap::new(),
         }
     }
 
@@ -427,8 +427,8 @@ impl Request {
     }
 
     /// Returns a reference to the existing local state.
-    pub fn local_state(&self) -> &TypeMap {
-        &self.local_state
+    pub fn local(&self) -> &TypeMap {
+        &self.local
     }
 
     /// Returns a mutuable reference to the existing local state.
@@ -442,13 +442,13 @@ impl Request {
     /// use http_types::{Url, Method, Request, Version};
     ///
     /// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
-    /// req.local_state_mut().insert("hello from the extension");
-    /// assert_eq!(req.local_state().get(), Some(&"hello from the extension"));
+    /// req.local_mut().insert("hello from the extension");
+    /// assert_eq!(req.local().get(), Some(&"hello from the extension"));
     /// #
     /// # Ok(()) }
     /// ```    
-    pub fn local_state_mut(&mut self) -> &mut TypeMap {
-        &mut self.local_state
+    pub fn local_mut(&mut self) -> &mut TypeMap {
+        &mut self.local
     }
 }
 

src/response.rs

@@ -37,7 +37,7 @@ pin_project_lite::pin_project! {
         receiver: sync::Receiver<crate::Result<Trailers>>,
         #[pin]
         body: Body,
-        local_state: TypeMap,
+        local: TypeMap,
     }
 }
 
@@ -52,7 +52,7 @@ impl Response {
             body: Body::empty(),
             sender: Some(sender),
             receiver,
-            local_state: TypeMap::new(),
+            local: TypeMap::new(),
         }
     }
 
@@ -392,9 +392,9 @@ impl Response {
         self.headers.values()
     }
 
-    /// Returns a reference to the existing local_state.
-    pub fn local_state(&self) -> &TypeMap {
-        &self.local_state
+    /// Returns a reference to the existing local.
+    pub fn local(&self) -> &TypeMap {
+        &self.local
     }
 
     /// Returns a mutuable reference to the existing local state.
@@ -408,13 +408,13 @@ impl Response {
     /// use http_types::{StatusCode, Response, Version};
     ///
     /// let mut res = Response::new(StatusCode::Ok);
-    /// res.local_state_mut().insert("hello from the extension");
-    /// assert_eq!(res.local_state().get(), Some(&"hello from the extension"));
+    /// res.local_mut().insert("hello from the extension");
+    /// assert_eq!(res.local().get(), Some(&"hello from the extension"));
     /// #
     /// # Ok(()) }
     /// ```    
-    pub fn local_state_mut(&mut self) -> &mut TypeMap {
-        &mut self.local_state
+    pub fn local_mut(&mut self) -> &mut TypeMap {
+        &mut self.local
     }
 }
 

src/type_map.rs

@@ -7,8 +7,13 @@ use std::collections::HashMap;
 use std::fmt;
 use std::hash::{BuildHasherDefault, Hasher};
 
-/// Map type that allows storing any `Sync + Send + 'static` type as local state
-/// on a `Request` or `Response`.
+/// Store and retrieve values by `TypeId`.
+///
+/// Map type that allows storing any `Sync + Send + 'static` type. Instances can
+/// be retrieved from [`Request::local`](struct.Request.html#method.local) +
+/// [`Response::local`](struct.Response.html#method.local) and
+/// [`Request::local_mut`](struct.Request.html#method.local_mut) +
+/// [`Response::local_mut`](struct.Response.html#method.local_mut).
 #[derive(Default)]
 pub struct TypeMap {
     map: Option<HashMap<TypeId, Box<dyn Any + Send + Sync>, BuildHasherDefault<IdHasher>>>,
@@ -17,7 +22,7 @@ pub struct TypeMap {
 impl TypeMap {
     /// Create an empty `TypeMap`.
     #[inline]
-    pub fn new() -> Self {
+    pub(crate) fn new() -> Self {
         Self { map: None }
     }