Struct rweb::openapi::Parameter[][src]

pub struct Parameter {
    pub name: Cow<'static, str>,
    pub location: Location,
    pub required: Option<bool>,
    pub schema: Option<Schema>,
    pub unique_items: Option<bool>,
    pub param_type: Option<Type>,
    pub format: Cow<'static, str>,
    pub description: Cow<'static, str>,
    pub style: Option<ParameterStyle>,
}

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.

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

Fields

name: Cow<'static, str>

The name of the parameter.

location: Location

values depend on parameter type may be header, query, ’path, formData`

required: Option<bool>schema: Option<Schema>unique_items: Option<bool>param_type: Option<Type>

string, number, boolean, integer, array, file ( only for formData )

format: Cow<'static, str>description: Cow<'static, str>

A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.

style: Option<ParameterStyle>

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.

Trait Implementations

impl Clone for Parameter[src]

impl Debug for Parameter[src]

impl Default for Parameter[src]

impl<'de> Deserialize<'de> for Parameter[src]

impl PartialEq<Parameter> for Parameter[src]

impl Serialize for Parameter[src]

impl StructuralPartialEq for Parameter[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,