reanme

Author: dignifiedquire

src/lib.rs

@@ -152,8 +152,10 @@ pub mod trailers;
 #[cfg(feature = "hyperium_http")]
 mod hyperium_http;
 
-/// Map of arbitrary types to extend the protocol.
-pub type Extensions = type_map::concurrent::TypeMap;
+/// Map type that allows storing any `Sync + Send + 'static` type as local state
+/// on a `Request` or `Response`.
+#[doc(inline)]
+pub use type_map::concurrent::TypeMap;
 
 // Not public API. Referenced by macro-generated code.
 #[doc(hidden)]

src/request.rs

@@ -12,7 +12,7 @@ use crate::headers::{
 use crate::mime::Mime;
 use crate::trailers::{Trailers, TrailersSender};
 use crate::Cookie;
-use crate::{Body, Extensions, Method, Url, Version};
+use crate::{Body, Method, TypeMap, Url, Version};
 
 pin_project_lite::pin_project! {
     /// An HTTP request.
@@ -35,7 +35,7 @@ pin_project_lite::pin_project! {
         receiver: sync::Receiver<crate::Result<Trailers>>,
         #[pin]
         body: Body,
-        extensions: Extensions,
+        local_state: TypeMap,
     }
 }
 
@@ -51,7 +51,7 @@ impl Request {
             body: Body::empty(),
             sender: Some(sender),
             receiver,
-            extensions: Extensions::new(),
+            local_state: TypeMap::new(),
         }
     }
 
@@ -426,12 +426,12 @@ impl Request {
         self.headers.values()
     }
 
-    /// Returns a reference to the existing extensions.
-    pub fn extensions(&self) -> &Extensions {
-        &self.extensions
+    /// Returns a reference to the existing local state.
+    pub fn local_state(&self) -> &TypeMap {
+        &self.local_state
     }
 
-    /// Returns a mutuable reference to the existing extensions.
+    /// Returns a mutuable reference to the existing local state.
     ///
     ///
     /// # Examples
@@ -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.extensions_mut().insert("hello from the extension");
-    /// assert_eq!(req.extensions().get(), Some(&"hello from the extension"));
+    /// req.local_state_mut().insert("hello from the extension");
+    /// assert_eq!(req.local_state().get(), Some(&"hello from the extension"));
     /// #
     /// # Ok(()) }
     /// ```    
-    pub fn extensions_mut(&mut self) -> &mut Extensions {
-        &mut self.extensions
+    pub fn local_state_mut(&mut self) -> &mut TypeMap {
+        &mut self.local_state
     }
 }
 

src/response.rs

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