Struct Header 

pub struct Header {
    pub description: Option<String>,
    pub required: Option<bool>,
    pub deprecated: Option<bool>,
    pub extensions: Extensions,
    /* private fields */
}

A response header, or a header used by an Encoding.

This is a Parameter Object without name and in, and without allowEmptyValue, which the specification refuses a header. Like a parameter it holds one HeaderShape and one Examples.

Fields

description: Option<String>

A description of the header. CommonMark syntax may be used.

required: Option<bool>

Whether the header is mandatory.

deprecated: Option<bool>

Whether the header is deprecated.

extensions: Extensions

Specification extensions.

Implementations

impl Header

pub fn new(schema: Schema) -> Self

Creates a header described by a schema.

pub fn with_content(media_type: impl Into<String>, value: MediaType) -> Self

Creates a header described by one media type.

pub fn shape(&self) -> &HeaderShape

How this header’s value is described.

pub fn shape_mut(&mut self) -> &mut HeaderShape

The same, mutably.

Handing out &mut costs nothing here: every HeaderShape is a valid description, so there is no combination a caller could reach by editing one that it could not reach by building one.

pub fn schema(&self) -> Option<&Schema>

The schema, when this header is described by one.

pub fn content(&self) -> Option<(&str, &MediaType)>

The media type and its description, when this header uses content.

pub fn style(&self) -> Option<HeaderStyle>

The declared style, if any.

pub fn with_style(self, style: HeaderStyle, explode: bool) -> Self

Sets the serialization style and explode flag.

A no-op on a content-described header, which has no style to set.

Naming HeaderStyle::Simple is not redundant even though it is the only style a header may take: the specification distinguishes a header that states it from one that leaves it out, and a description that stated it is emitted back the way it arrived.

pub fn examples(&self) -> Option<&Examples>

The examples this header carries, if it carries any.

pub fn example(&self) -> Option<&Value>

The inline example, when the value is shown with one.

pub fn named_examples(&self) -> Option<&Map<RefOr<Example>>>

The named examples, when the value is shown with those.

pub fn with_example(self, value: impl Into<Value>) -> Self

Shows the value with one inline example.

Replaces any named examples: the two forms exclude each other, so there is no state that holds both.

pub fn with_named_example( self, name: impl Into<String>, example: Example, ) -> Self

Adds a named example, replacing any inline one.

pub fn with_named_example_ref( self, name: impl Into<String>, example: Ref, ) -> Self

Adds a named example held in Components::examples.

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

Sets the description.

pub fn required(self, required: bool) -> Self

Marks the header mandatory.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Self

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: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

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