Struct Parameter

pub struct Parameter<S> {

    pub description: Option<String>,
    pub in_: ParameterIn,
    pub name: String,
    pub required: bool,
    pub schema: Option<S>,
    pub data_type: Option<DataType>,
    pub format: Option<DataTypeFormat>,
    pub items: Option<Items>,
    pub collection_format: Option<CollectionFormat>,
    pub allow_empty_value: bool,
    pub default: Option<Value>,
    pub maximum: Option<f32>,
    pub exclusive_maximum: Option<bool>,
    pub minimum: Option<f32>,
    pub exclusive_minimum: Option<bool>,
    pub max_length: Option<u32>,
    pub min_length: Option<u32>,
    pub pattern: Option<String>,
    pub max_items: Option<u32>,
    pub min_items: Option<u32>,
    pub unique_items: bool,
    pub multiple_of: Option<f32>,
    pub enum_: Vec<Value>,
}

Request parameter object.

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterObject

Fields

description: Option<String>

in_: ParameterIn

name: String

required: bool

schema: Option<S>

data_type: Option<DataType>

format: Option<DataTypeFormat>

items: Option<Items>

collection_format: Option<CollectionFormat>

allow_empty_value: bool

default: Option<Value>

maximum: Option<f32>

exclusive_maximum: Option<bool>

minimum: Option<f32>

exclusive_minimum: Option<bool>

max_length: Option<u32>

min_length: Option<u32>

pattern: Option<String>

max_items: Option<u32>

min_items: Option<u32>

unique_items: bool

multiple_of: Option<f32>

enum_: Vec<Value>

Implementations

impl<S> Parameter<Resolvable<S>>

where S: Schema,

pub fn check(&self, path: &str) -> Result<(), ValidationError>

Checks the validity of this parameter using the relative URL path it’s associated with.

Trait Implementations

impl<S: Clone> Clone for Parameter<S>

fn clone(&self) -> Parameter<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Parameter<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for Parameter<S>

fn default() -> Parameter<S>

Returns the “default value” for a type.

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

where S: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Parameter<DefaultSchemaRaw>> for Either<Parameter, Either<RequestBody, Option<Schema>>>

fn from(v2: DefaultParameterRaw) -> Self

Converts to this type from the input type.

impl<S: PartialEq> PartialEq for Parameter<S>

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

Tests for self and other values to be equal, and is used by ==.

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<S> Serialize for Parameter<S>

where S: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S> StructuralPartialEq for Parameter<S>