Struct Header 

pub struct Header {

    pub reference: Option<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub required: Option<bool>,
    pub deprecated: Option<bool>,
    pub allow_empty_value: Option<bool>,
    pub style: Option<String>,
    pub explode: Option<bool>,
    pub allow_reserved: Option<bool>,
    pub schema: Option<Schema>,
    pub example: Option<Value>,
    pub examples: Option<BTreeMap<String, Example>>,
    pub content: Option<BTreeMap<String, MediaType>>,
}

HTTP header definition.

Fields

reference: Option<String>

Reference to a header definition.

summary: Option<String>

Short summary of the header.

description: Option<String>

Description of the header. CommonMark syntax may be used.

required: Option<bool>

Whether the header is required (default: false).

deprecated: Option<bool>

Whether the header is deprecated (default: false).

allow_empty_value: Option<bool>

Whether empty values are allowed (default: false).

style: Option<String>

Serialization style for the header value.

explode: Option<bool>

Whether to generate separate parameters for array/object values.

allow_reserved: Option<bool>

Whether to allow reserved characters.

schema: Option<Schema>

Schema defining the header type.

example: Option<Value>

Example value for the header.

examples: Option<BTreeMap<String, Example>>

Multiple examples for the header.

content: Option<BTreeMap<String, MediaType>>

Content representation for the header.

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 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.