Struct Header 

pub struct Header<T> {
    pub value: T,
    pub name: String,
}

Header extractor for individual HTTP headers.

Extracts a single header value by name from the request. The header name is derived from the generic type’s name, converting from snake_case to Header-Case (e.g., x_request_id -> X-Request-Id).

For required headers, extraction failure returns 400 Bad Request. Use Option<Header<T>> for optional headers.

Example

use fastapi_core::extract::Header;

// Extract Authorization header (required)
async fn protected(auth: Header<String>) -> impl IntoResponse {
    format!("Authorized with: {}", auth.0)
}

// Extract optional header
async fn optional_header(trace_id: Option<Header<String>>) -> impl IntoResponse {
    match trace_id {
        Some(Header(id)) => format!("Trace: {id}"),
        None => "No trace".into(),
    }
}

Fields

value: T

The extracted header value.

name: String

The original header name used for extraction.

Implementations

impl<T> Header<T>

pub fn new(name: impl Into<String>, value: T) -> Self

Create a new Header wrapper.

pub fn into_inner(self) -> T

Unwrap the inner value.

Trait Implementations

impl<T: Clone> Clone for Header<T>

fn clone(&self) -> Header<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Header<T>

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

Formats the value using the given formatter.

impl<T> Deref for Header<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Header<T>

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

Mutably dereferences the value.