Struct utoipa::openapi::content::ContentBuilder

pub struct ContentBuilder { /* private fields */ }

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

Implementations

impl ContentBuilder

pub fn new() -> ContentBuilder

Constructs a new ContentBuilder.

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

Add schema.

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

Add example of schema.

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.

pub fn build(self) -> Content

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

Trait Implementations

impl Default for ContentBuilder

fn default() -> ContentBuilder

Returns the “default value” for a type.

impl From<Content> for ContentBuilder

fn from(value: Content) -> Self

Converts to this type from the input type.

impl From<ContentBuilder> for Content

fn from(value: ContentBuilder) -> Self

Converts to this type from the input type.