Struct utoipa::openapi::path::ParameterBuilder

source ·
pub struct ParameterBuilder { /* private fields */ }
Expand description

Builder for Parameter with chainable configuration methods to create a new Parameter.

Implementations§

source§

impl ParameterBuilder

source

pub fn new() -> ParameterBuilder

Constructs a new ParameterBuilder.

source

pub fn build(self) -> Parameter

Constructs a new Parameter taking all fields values from this object.

source§

impl ParameterBuilder

source

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

Add name of the Parameter.

source

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

Add in of the Parameter.

source

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

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

source

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

Add or change description of the Parameter.

source

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

Add or change Parameter deprecated declaration.

source

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

Add or change Parameters schema.

source

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

Add or change serialization style of Parameter.

source

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

Define whether Parameters are exploded or not.

source

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

Add or change whether Parameter should allow reserved characters.

source

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

Add or change example of Parameter’s potential value.

Trait Implementations§

source§

impl Default for ParameterBuilder

source§

fn default() -> Self

Returns the “default value” for a type. 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.

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> 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, U> TryFrom<U> for T
where 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 T
where 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.