Struct utoipa::openapi::header::Header

#[non_exhaustive]
pub struct Header {
    pub schema: RefOr<Schema>,
    pub description: Option<String>,
}

Implements OpenAPI Header Object for response headers.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

schema: RefOr<Schema>

Schema of header type.

description: Option<String>

Additional descripiton of the header value.

Implementations

impl Header

pub fn new<C: Into<RefOr<Schema>>>(component: C) -> Self

Construct a new Header with custom schema. If you wish to construct a default header with String type you can use Header::default function.

Examples

Create new Header with integer type.

let header = Header::new(Object::with_type(SchemaType::Integer));

Create a new Header with default type String

let header = Header::default();

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Header

fn default() -> Self

Returns the “default value” for a type.

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 From<Header> for HeaderBuilder

fn from(value: Header) -> Self

Converts to this type from the input type.

impl From<HeaderBuilder> for Header

fn from(value: HeaderBuilder) -> Self

Converts to this type from the input type.

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.