Struct Header 

pub struct Header {
    pub type: TypeRef,
    pub required: bool,
    pub deprecated: bool,
    pub documentation: Option<String>,
    pub examples: Vec<(String, Example)>,
    pub style: Option<ParameterStyle>,
    pub explode: bool,
    pub allow_reserved: bool,
    pub allow_empty_value: bool,
    pub location: Option<SpecLocation>,
}

OAS Header Object. Distinct from Parameter because headers have a fixed serialization style (no style/explode), and because required carries different semantics here: “documented as always present in the response” rather than “the request must include this”.

The header’s name lives on the surrounding tuple key (Vec<(String, Header)>), not on this struct.

Fields

type: TypeRef

required: bool

deprecated: bool

documentation: Option<String>

examples: Vec<(String, Example)>

style: Option<ParameterStyle>

OAS Header Object inherits the Parameter Object’s serialization fields. The spec fixes style to simple for headers, but captures the value verbatim so spec-strict consumers (validators, doc generators) can see what was declared. Most generators ignore this slot.

explode: bool

OAS explode. Defaults to false per Header Object semantics.

allow_reserved: bool

OAS allowReserved. Permits raw RFC 3986 reserved characters in the rendered header value. Defaults to false.

allow_empty_value: bool

OAS allowEmptyValue. Defaults to false.

location: Option<SpecLocation>

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Header

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Header

fn eq(&self, other: &Header) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Header

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Header