feat: implement extensions

Author: dignifiedquire

Cargo.toml

@@ -26,6 +26,7 @@ omnom = "2.1.1"
 # features: hyperium/http
 http = { version = "0.2.0", optional = true }
 anyhow = "1.0.26"
+type-map = "0.2.0"
 
 [dev-dependencies]
 http = "0.2.0"

src/headers/constants.rs

@@ -17,3 +17,31 @@ pub const TRANSFER_ENCODING: HeaderName = HeaderName::from_lowercase_str("transf
 
 /// The `Date` Header
 pub const DATE: HeaderName = HeaderName::from_lowercase_str("date");
+
+/// The `Origin` Header
+pub const ORIGIN: HeaderName = HeaderName::from_lowercase_str("origin");
+
+/// The `access-control-max-age` Header
+pub const ACCESS_CONTROL_MAX_AGE: HeaderName =
+    HeaderName::from_lowercase_str("access-control-max-age");
+/// The `access-control-allow-origin` Header
+pub const ACCESS_CONTROL_ALLOW_ORIGIN: HeaderName =
+    HeaderName::from_lowercase_str("access-control-allow-origin");
+/// The `access-control-allow-headers` Header
+pub const ACCESS_CONTROL_ALLOW_HEADERS: HeaderName =
+    HeaderName::from_lowercase_str("access-control-allow-headers");
+/// The `access-control-allow-methods` Header
+pub const ACCESS_CONTROL_ALLOW_METHODS: HeaderName =
+    HeaderName::from_lowercase_str("access-control-allow-methods");
+/// The `access-control-expose-headers` Header
+pub const ACCESS_CONTROL_EXPOSE_HEADERS: HeaderName =
+    HeaderName::from_lowercase_str("access-control-expose-headers");
+/// The `access-control-request-method` Header
+pub const ACCESS_CONTROL_REQUEST_METHOD: HeaderName =
+    HeaderName::from_lowercase_str("access-control-request-method");
+/// The `access-control-request-headers` Header
+pub const ACCESS_CONTROL_REQUEST_HEADERS: HeaderName =
+    HeaderName::from_lowercase_str("access-control-request-headers");
+/// The `access-control-allow-credentials` Header
+pub const ACCESS_CONTROL_ALLOW_CREDENTIALS: HeaderName =
+    HeaderName::from_lowercase_str("access-control-allow-credentials");

src/lib.rs

@@ -152,6 +152,9 @@ 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;
+
 // Not public API. Referenced by macro-generated code.
 #[doc(hidden)]
 pub mod private {

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, Method, Url, Version};
+use crate::{Body, Extensions, Method, Url, Version};
 
 pin_project_lite::pin_project! {
     /// An HTTP request.
@@ -35,6 +35,7 @@ pin_project_lite::pin_project! {
         receiver: sync::Receiver<crate::Result<Trailers>>,
         #[pin]
         body: Body,
+        extensions: Extensions,
     }
 }
 
@@ -50,6 +51,7 @@ impl Request {
             body: Body::empty(),
             sender: Some(sender),
             receiver,
+            extensions: Extensions::new(),
         }
     }
 
@@ -423,6 +425,31 @@ impl Request {
     pub fn header_values<'a>(&'a self) -> Values<'a> {
         self.headers.values()
     }
+
+    /// Returns a reference to the existing extensions.
+    pub fn extensions(&self) -> &Extensions {
+        &self.extensions
+    }
+
+    /// Returns a mutuable reference to the existing extensions.
+    ///
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// # fn main() -> Result<(), http_types::Error> {
+    /// #
+    /// 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"));
+    /// #
+    /// # Ok(()) }
+    /// ```    
+    pub fn extensions_mut(&mut self) -> &mut Extensions {
+        &mut self.extensions
+    }
 }
 
 impl Read for Request {

src/response.rs

@@ -11,7 +11,7 @@ use crate::headers::{
 };
 use crate::mime::Mime;
 use crate::trailers::{Trailers, TrailersSender};
-use crate::{Body, Cookie, StatusCode, Version};
+use crate::{Body, Cookie, Extensions, StatusCode, Version};
 
 pin_project_lite::pin_project! {
     /// An HTTP response.
@@ -37,6 +37,7 @@ pin_project_lite::pin_project! {
         receiver: sync::Receiver<crate::Result<Trailers>>,
         #[pin]
         body: Body,
+        extensions: Extensions,
     }
 }
 
@@ -51,6 +52,7 @@ impl Response {
             body: Body::empty(),
             sender: Some(sender),
             receiver,
+            extensions: Extensions::new(),
         }
     }
 
@@ -389,6 +391,31 @@ impl Response {
     pub fn header_values<'a>(&'a self) -> Values<'a> {
         self.headers.values()
     }
+
+    /// Returns a reference to the existing extensions.
+    pub fn extensions(&self) -> &Extensions {
+        &self.extensions
+    }
+
+    /// Returns a mutuable reference to the existing extensions.
+    ///
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// # fn main() -> Result<(), http_types::Error> {
+    /// #
+    /// 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"));
+    /// #
+    /// # Ok(()) }
+    /// ```    
+    pub fn extensions_mut(&mut self) -> &mut Extensions {
+        &mut self.extensions
+    }
 }
 
 impl Read for Response {