ContentBuilder

Struct 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>(self, schema: Option<I>) -> ContentBuilder
where I: Into<RefOr<Schema>>,

Add schema.

Source

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

Add example of schema.

Source

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

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, E>(self, property_name: S, encoding: E) -> ContentBuilder
where S: Into<String>, E: Into<Encoding>,

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.

Source

pub fn extensions(self, extensions: Option<Extensions>) -> ContentBuilder

Add openapi extensions (x-something) of the API.

Trait Implementations§

Source§

impl Default for ContentBuilder

Source§

fn default() -> ContentBuilder

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

impl From<Content> for ContentBuilder

Source§

fn from(value: Content) -> ContentBuilder

Converts to this type from the input type.
Source§

impl From<ContentBuilder> for Content

Source§

fn from(value: ContentBuilder) -> Content

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more