Struct axum::TypedHeader
source · [−]pub struct TypedHeader<T>(pub T);
headers
only.Expand description
Extractor and response that works with typed header values from headers
.
As extractor
In general, it’s recommended to extract only the needed headers via TypedHeader
rather than
removing all headers with the HeaderMap
extractor.
use axum::{
TypedHeader,
headers::UserAgent,
routing::get,
Router,
};
async fn users_teams_show(
TypedHeader(user_agent): TypedHeader<UserAgent>,
) {
// ...
}
let app = Router::new().route("/users/:user_id/team/:team_id", get(users_teams_show));
As response
use axum::{
TypedHeader,
response::IntoResponse,
headers::ContentType,
};
async fn handler() -> (TypedHeader<ContentType>, &'static str) {
(
TypedHeader(ContentType::text_utf8()),
"Hello, World!",
)
}
Tuple Fields
0: T
Trait Implementations
sourceimpl<T: Clone> Clone for TypedHeader<T>
impl<T: Clone> Clone for TypedHeader<T>
sourcefn clone(&self) -> TypedHeader<T>
fn clone(&self) -> TypedHeader<T>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<T: Debug> Debug for TypedHeader<T>
impl<T: Debug> Debug for TypedHeader<T>
sourceimpl<T> Deref for TypedHeader<T>
impl<T> Deref for TypedHeader<T>
sourceimpl<T, B> FromRequest<B> for TypedHeader<T> where
T: Header,
B: Send,
impl<T, B> FromRequest<B> for TypedHeader<T> where
T: Header,
B: Send,
type Rejection = TypedHeaderRejection
type Rejection = TypedHeaderRejection
If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response. Read more
sourcefn from_request<'life0, 'async_trait>(
req: &'life0 mut RequestParts<B>
) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn from_request<'life0, 'async_trait>(
req: &'life0 mut RequestParts<B>
) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Perform the extraction.
sourceimpl<T> IntoResponse for TypedHeader<T> where
T: Header,
impl<T> IntoResponse for TypedHeader<T> where
T: Header,
sourcefn into_response(self) -> Response
fn into_response(self) -> Response
Create a response.
sourceimpl<T> IntoResponseParts for TypedHeader<T> where
T: Header,
impl<T> IntoResponseParts for TypedHeader<T> where
T: Header,
type Error = Infallible
type Error = Infallible
The type returned in the event of an error. Read more
sourcefn into_response_parts(
self,
res: ResponseParts
) -> Result<ResponseParts, Self::Error>
fn into_response_parts(
self,
res: ResponseParts
) -> Result<ResponseParts, Self::Error>
Set parts of the response
impl<T: Copy> Copy for TypedHeader<T>
Auto Trait Implementations
impl<T> RefUnwindSafe for TypedHeader<T> where
T: RefUnwindSafe,
impl<T> Send for TypedHeader<T> where
T: Send,
impl<T> Sync for TypedHeader<T> where
T: Sync,
impl<T> Unpin for TypedHeader<T> where
T: Unpin,
impl<T> UnwindSafe for TypedHeader<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more