Struct utoipa::openapi::content::ContentBuilder

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

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

Implementations§

source§

impl ContentBuilder

source

pub fn new() -> ContentBuilder

Constructs a new ContentBuilder.

source

pub fn build(self) -> Content

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

source§

impl ContentBuilder

source

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

Add schema.

source

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

Add example of schema.

source

pub fn examples_from_iter<E: IntoIterator<Item = (N, V)>, N: Into<String>, V: Into<RefOr<Example>>>( self, examples: E, ) -> Self

Add iterator of (N, V) where N is name of example and V is Example to Content of a request body or response body.

Content::examples and Content::example are mutually exclusive. If both are defined examples will override value in example.

source

pub fn encoding<S: Into<String>, E: Into<Encoding>>( self, property_name: S, encoding: E, ) -> Self

Add an encoding.

The property_name MUST exist in the Content::schema as a property, with schema being a Schema::Object and this object containing the same property key in Object::properties.

The encoding object SHALL only apply to request_body objects when the media type is multipart or application/x-www-form-urlencoded.

Trait Implementations§

source§

impl Default for ContentBuilder

source§

fn default() -> Self

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

impl From<Content> for ContentBuilder

source§

fn from(value: Content) -> Self

Converts to this type from the input type.
source§

impl From<ContentBuilder> for Content

source§

fn from(value: ContentBuilder) -> 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.