Struct NamedHeader 

pub struct NamedHeader<T, N> {
    pub value: T,
    /* private fields */
}

Named header extractor with explicit header name.

Use this when the header name doesn’t match a type name.

Example

use fastapi_core::extract::NamedHeader;

async fn handler(
    auth: NamedHeader<String, AuthorizationHeader>,
    trace: NamedHeader<String, XRequestIdHeader>,
) -> impl IntoResponse {
    // ...
}

struct AuthorizationHeader;
impl HeaderName for AuthorizationHeader {
    const NAME: &'static str = "Authorization";
}

Fields

value: T

The extracted header value.

Implementations

impl<T, N> NamedHeader<T, N>

pub fn new(value: T) -> Self

Create a new named header wrapper.

pub fn into_inner(self) -> T

Unwrap the inner value.

Trait Implementations

impl<T: Clone, N: Clone> Clone for NamedHeader<T, N>

fn clone(&self) -> NamedHeader<T, N>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, N: Debug> Debug for NamedHeader<T, N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, N> Deref for NamedHeader<T, N>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, N> DerefMut for NamedHeader<T, N>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T, N> FromRequest for NamedHeader<T, N>

where T: FromHeaderValue + Send + Sync + 'static, N: HeaderName + Send + Sync + 'static,

type Error = HeaderExtractError

Error type when extraction fails.

async fn from_request( _ctx: &RequestContext, req: &mut Request, ) -> Result<Self, Self::Error>

Extract a value from the request.