Struct Header 

pub struct Header<H: DocumentedHeader>(pub String, pub PhantomData<H>);

Extracts a header value by name, where the name is supplied type-level via DocumentedHeader::name. Modeled after axum_extra::TypedHeader but using our own DocumentedHeader trait so the macro pass can resolve the wire name at runtime without depending on the foreign headers crate.

Example

use doxa::{DocumentedHeader, Header};

pub struct XApiKey;
impl DocumentedHeader for XApiKey {
    fn name() -> &'static str { "X-Api-Key" }
    fn description() -> &'static str { "Tenant API key" }
}

async fn handler(Header(key): Header<XApiKey>) -> &'static str {
    // `key` is the raw header value as a String.
    "ok"
}

Handlers extracting via Header<H> are auto-registered in the OpenAPI spec by the #[get] / #[post] / etc. macros — the macro recognizes the wrapper type and emits a params(DocHeaderEntry<H>) entry. No explicit headers(...) annotation is needed for the documented case.

Tuple Fields

0: String

1: PhantomData<H>

Trait Implementations

impl<H: DocumentedHeader> DocHeaderParams for Header<H>

fn describe(op: &mut Operation)

Append header parameters to op.parameters.

impl<S, H> FromRequestParts<S> for Header<H>

where S: Send + Sync, H: DocumentedHeader,

type Rejection = (StatusCode, &'static str)

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.