Struct utoipa::openapi::path::Parameter

source ·
#[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>, /* private fields */ }
Expand description

Fields (Non-exhaustive)§

This struct is marked as 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.

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

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

Implementations§

source§

impl Parameter

source

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

Constructs a new required Parameter with given name.

Trait Implementations§

source§

impl Clone for Parameter

source§

fn clone(&self) -> Parameter

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Default for Parameter

source§

fn default() -> Parameter

Returns the “default value” for a type. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<Parameter> for ParameterBuilder

source§

fn from(value: Parameter) -> Self

Converts to this type from the input type.
source§

impl From<ParameterBuilder> for Parameter

source§

fn from(value: ParameterBuilder) -> Self

Converts to this type from the input type.
source§

impl PartialEq<Parameter> for Parameter

source§

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

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

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.
source§

impl Serialize for Parameter

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl StructuralPartialEq for Parameter

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,