Struct salvo_oapi::parameter::Parameter

#[non_exhaustive]
pub struct Parameter {
    pub name: String,
    pub parameter_in: ParameterIn,
    pub description: Option<String>,
    pub required: Required,
    pub deprecated: Option<Deprecated>,
    pub schema: Option<RefOr<Schema>>,
    pub style: Option<ParameterStyle>,
    pub explode: Option<bool>,
    pub allow_reserved: Option<bool>,
    pub extensions: Option<HashMap<String, Value>>,
    /* private fields */
}

Implements OpenAPI Parameter Object for Operation.

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.

name: String

Name of the parameter.

• For ParameterIn::Path this must in accordance to path templating.
• For ParameterIn::Query Content-Type or Authorization value will be ignored.

parameter_in: ParameterIn

Parameter location.

description: Option<String>

Markdown supported description of the parameter.

required: Required

Declares whether the parameter is required or not for api.

• For ParameterIn::Path this must and will be Required::True.

deprecated: Option<Deprecated>

Declares the parameter deprecated status.

schema: Option<RefOr<Schema>>

Schema of the parameter. Typically Schema::Object is used.

style: Option<ParameterStyle>

Describes how Parameter is being serialized depending on Parameter::schema (type of a content). Default value is based on ParameterIn.

explode: Option<bool>

When true it will generate separate parameter value for each parameter with array and object type. This is also true by default for ParameterStyle::Form.

With explode false:

color=blue,black,brown

With explode true:

color=blue&color=black&color=brown

allow_reserved: Option<bool>

Defines whether parameter should allow reserved characters defined by RFC3986 :/?#[]@!$&'()*+,;=. This is only applicable with ParameterIn::Query. Default value is false.

extensions: Option<HashMap<String, Value>>

Optional extensions “x-something”

Implementations

impl Parameter

pub fn new<S: Into<String>>(name: S) -> Self

Constructs a new required Parameter with given name.

pub fn name<I: Into<String>>(self, name: I) -> Self

Add name of the Parameter.

pub fn parameter_in(self, parameter_in: ParameterIn) -> Self

Add in of the Parameter.

pub fn merge(&mut self, other: Parameter) -> bool

Fill Parameter with values from another Parameter. Fields will replaced if it is not set.

pub fn required(self, required: impl Into<Required>) -> Self

Add required declaration of the Parameter. If ParameterIn::Path is defined this is always Required::True.

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

Add or change description of the Parameter.

pub fn deprecated<D: Into<Deprecated>>(self, deprecated: D) -> Self

Add or change Parameter deprecated declaration.

pub fn schema<I: Into<RefOr<Schema>>>(self, component: I) -> Self

Add or change Parameters schema.

pub fn style(self, style: ParameterStyle) -> Self

Add or change serialization style of Parameter.

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

Define whether Parameters are exploded or not.

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

Add or change whether Parameter should allow reserved characters.

pub fn example(self, example: Value) -> Self

Add or change example of Parameter’s potential value.

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 Default for Parameter

fn default() -> Parameter

Returns the “default value” for a type.

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 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