Skip to main content

ParameterShape

Enum ParameterShape 

Source
pub enum ParameterShape {
    Schema {
        schema: Schema,
        style: Option<Style>,
        explode: Option<bool>,
        allow_reserved: Option<bool>,
    },
    Content {
        media_type: String,
        value: Box<MediaType>,
    },
}
Expand description

How a parameter’s value is described.

A parameter carries schema or content, never both and never neither. style, explode and allowReserved only mean anything alongside a schema, so they live in that variant rather than beside it — setting a style on a content-described parameter is not a mistake to report, it is a sentence with nowhere to be written.

Variants§

§

Schema

The simple case: a schema, plus how its value is serialized.

Fields

§schema: Schema

The schema defining the parameter’s type.

§style: Option<Style>

How the value is serialized.

§explode: Option<bool>

Whether an array or object generates one parameter per member.

§allow_reserved: Option<bool>

Whether reserved URI characters may appear unencoded.

§

Content

The complex case: one media type describing the value.

The specification allows exactly one entry, so this holds one pair rather than a map that has to be counted. Boxed because a MediaType dwarfs the schema-side fields, and every parameter would otherwise pay for the larger of the two.

Fields

§media_type: String

The media type the value is carried as.

§value: Box<MediaType>

What that media type describes.

Trait Implementations§

Source§

impl Clone for ParameterShape

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ParameterShape

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for ParameterShape

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ParameterShape

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 T
where 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 T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.