Struct Header

pub struct Header {

    pub description: Option<String>,
    pub type: ItemsType,
    pub format: Option<String>,
    pub items: Option<Box<Items>>,
    pub collection_format: Option<String>,
    pub default: Option<Value>,
    pub maximum: Option<Number>,
    pub exclusive_maximum: Option<bool>,
    pub minimum: Option<Number>,
    pub exclusive_minimum: Option<bool>,
    pub max_length: Option<Value>,
    pub min_length: Option<Number>,
    pub pattern: Option<String>,
    pub max_items: Option<Number>,
    pub min_items: Option<Number>,
    pub unique_items: Option<bool>,
    pub enum: Option<Vec<Value>>,
    pub multiple_of: Option<Number>,
    pub extensions: Extensions,
}

Header

Fields

description: Option<String>

A short description of the header.

type: ItemsType

The internal type of the array. The value MUST be one of “string”, “number”, “integer”, “boolean”, or “array”. Files and models are not allowed.

format: Option<String>

The extending format for the previously mentioned type. See Data Type Formats for further details.

items: Option<Box<Items>>

Required if type is “array”. Describes the type of items in the array.

collection_format: Option<String>

Determines the format of the array if type array is used.

default: Option<Value>

Declares the value of the parameter that the server will use if none is provided, for example a “count” to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: “default” has no meaning for required parameters.)

maximum: Option<Number>

exclusive_maximum: Option<bool>

minimum: Option<Number>

exclusive_minimum: Option<bool>

max_length: Option<Value>

min_length: Option<Number>

pattern: Option<String>

max_items: Option<Number>

min_items: Option<Number>

unique_items: Option<bool>

enum: Option<Vec<Value>>

multiple_of: Option<Number>

extensions: Extensions

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

const 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