viz_core/types/
header.rs

1//! Represents a header extractor.
2
3use std::{
4    fmt,
5    ops::{Deref, DerefMut},
6};
7
8use crate::{
9    header, headers::HeaderMapExt, Error, FromRequest, IntoResponse, Request, Response, Result,
10    StatusCode, ThisError,
11};
12
13/// Extracts a header from the headers of a request.
14pub struct Header<T>(pub T);
15
16impl<T> Header<T> {
17    /// Create new `Header` instance.
18    #[inline]
19    pub const fn new(t: T) -> Self {
20        Self(t)
21    }
22
23    /// Consumes the Header, returning the wrapped value.
24    #[inline]
25    pub fn into_inner(self) -> T {
26        self.0
27    }
28}
29
30impl<T> Clone for Header<T>
31where
32    T: Clone,
33{
34    fn clone(&self) -> Self {
35        Self(self.0.clone())
36    }
37}
38
39impl<T> AsRef<T> for Header<T> {
40    fn as_ref(&self) -> &T {
41        &self.0
42    }
43}
44
45impl<T> Deref for Header<T> {
46    type Target = T;
47
48    fn deref(&self) -> &T {
49        &self.0
50    }
51}
52
53impl<T> DerefMut for Header<T> {
54    fn deref_mut(&mut self) -> &mut T {
55        &mut self.0
56    }
57}
58
59impl<T> fmt::Debug for Header<T>
60where
61    T: fmt::Debug,
62{
63    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
64        T::fmt(self, f)
65    }
66}
67
68impl<T> FromRequest for Header<T>
69where
70    T: headers::Header,
71{
72    type Error = HeaderError;
73
74    async fn extract(req: &mut Request) -> Result<Self, Self::Error> {
75        req.headers()
76            .typed_try_get::<T>()
77            .map_err(|_| HeaderError::InvalidName(T::name()))
78            .and_then(|v| v.ok_or_else(|| HeaderError::MissingName(T::name())))
79            .map(Self)
80    }
81}
82
83/// Rejects with an error when header extraction fails.
84#[derive(Debug, ThisError)]
85pub enum HeaderError {
86    /// Invalid header name.
87    #[error("Invalid header name {0}")]
88    InvalidName(&'static header::HeaderName),
89    /// Missing header name.
90    #[error("Missing header name {0}")]
91    MissingName(&'static header::HeaderName),
92    /// Missing header value.
93    #[error("Invalid header value {0}")]
94    InvalidValue(header::InvalidHeaderValue),
95}
96
97impl IntoResponse for HeaderError {
98    fn into_response(self) -> Response {
99        (StatusCode::INTERNAL_SERVER_ERROR, self.to_string()).into_response()
100    }
101}
102
103impl From<HeaderError> for Error {
104    fn from(e: HeaderError) -> Self {
105        e.into_error()
106    }
107}
viz_core/types/header.rs

viz_core/types/
header.rs
