Add support for extracting typed headers (#18)

Uses the `headers` crate.
2026-08-25 00:00:23 +02:00 · 2021-06-15 21:27:21 +02:00
parent 2f6699aeae
commit b6e67eefd7
5 changed files with 91 additions and 1 deletions
@@ -766,3 +766,44 @@ macro_rules! impl_from_request_tuple {
 }

 impl_from_request_tuple!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16);
+
+/// Extractor that extracts a typed header value from [`headers`].
+///
+/// # Example
+///
+/// ```rust,no_run
+/// use awebframework::{extract::TypedHeader, prelude::*};
+/// use headers::UserAgent;
+///
+/// async fn users_teams_show(
+///     TypedHeader(user_agent): TypedHeader<UserAgent>,
+/// ) {
+///     // ...
+/// }
+///
+/// let app = route("/users/:user_id/team/:team_id", get(users_teams_show));
+/// ```
+#[cfg(feature = "headers")]
+#[cfg_attr(docsrs, doc(cfg(feature = "headers")))]
+#[derive(Debug, Clone, Copy)]
+pub struct TypedHeader<T>(pub T);
+
+#[cfg(feature = "headers")]
+#[cfg_attr(docsrs, doc(cfg(feature = "headers")))]
+#[async_trait]
+impl<T> FromRequest for TypedHeader<T>
+where
+    T: headers::Header,
+{
+    type Rejection = rejection::TypedHeaderRejection;
+
+    async fn from_request(req: &mut Request<Body>) -> Result<Self, Self::Rejection> {
+        let header_values = req.headers().get_all(T::name());
+        T::decode(&mut header_values.iter())
+            .map(Self)
+            .map_err(|err| rejection::TypedHeaderRejection {
+                err,
+                name: T::name(),
+            })
+    }
+}
@@ -1,5 +1,6 @@
 //! Rejection response types.

+use http::StatusCode;
 use tower::BoxError;

 use super::IntoResponse;
@@ -341,3 +342,22 @@ where
        }
    }
 }
+
+/// Rejection used for [`TypedHeader`](super::TypedHeader).
+#[cfg(feature = "headers")]
+#[cfg_attr(docsrs, doc(cfg(feature = "headers")))]
+#[derive(Debug)]
+pub struct TypedHeaderRejection {
+    pub(super) name: &'static http::header::HeaderName,
+    pub(super) err: headers::Error,
+}
+
+#[cfg(feature = "headers")]
+#[cfg_attr(docsrs, doc(cfg(feature = "headers")))]
+impl IntoResponse for TypedHeaderRejection {
+    fn into_response(self) -> http::Response<Body> {
+        let mut res = format!("{} ({})", self.err, self.name).into_response();
+        *res.status_mut() = StatusCode::BAD_REQUEST;
+        res
+    }
+}