Struct HeaderParam 

pub struct HeaderParam { /* private fields */ }

One header parameter descriptor. Construct via HeaderParam::typed / HeaderParam::typed_optional for type-safe declarations driven by DocumentedHeader, or via HeaderParam::required / HeaderParam::optional for ad-hoc string names.

Implementations

impl HeaderParam

pub fn typed<H: DocumentedHeader>() -> Self

Build a required header from a DocumentedHeader marker. Resolves the name and metadata at the time of the call.

pub fn typed_optional<H: DocumentedHeader>() -> Self

Build an optional header from a DocumentedHeader marker.

pub fn required(name: impl Into<String>) -> Self

Build an ad-hoc required header from a string name. Prefer HeaderParam::typed when a marker type is available.

pub fn optional(name: impl Into<String>) -> Self

Build an ad-hoc optional header from a string name.

pub fn description(self, d: impl Into<String>) -> Self

Set the description (chainable).

pub fn example(self, e: impl Into<String>) -> Self

Set the example value (chainable).

Trait Implementations

impl Clone for HeaderParam

fn clone(&self) -> HeaderParam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderParam

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

Formats the value using the given formatter.