Enum openapiv3::Parameter

pub enum Parameter {
    Query {
        parameter_data: ParameterData,
        allow_reserved: bool,
        style: QueryStyle,
        allow_empty_value: Option<bool>,
    },
    Header {
        parameter_data: ParameterData,
        style: HeaderStyle,
    },
    Path {
        parameter_data: ParameterData,
        style: PathStyle,
    },
    Cookie {
        parameter_data: ParameterData,
        style: CookieStyle,
    },
}

Variants

Query

Fields

parameter_data: ParameterData

allow_reserved: bool

Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&’()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false.

style: QueryStyle

Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.

allow_empty_value: Option<bool>

Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored.

Header

Fields

parameter_data: ParameterData

style: HeaderStyle

Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.

Path

Fields

parameter_data: ParameterData

style: PathStyle

Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.

Cookie

Fields

parameter_data: ParameterData

style: CookieStyle

Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.

Implementations

impl Parameter

pub fn parameter_data(self) -> ParameterData

Returns the parameter_data field of this ParameterData.

pub fn parameter_data_ref(&self) -> &ParameterData

Returns the parameter_data field of this ParameterData by reference.

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Parameter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Parameter> for Parameter

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Parameter

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 Parameter