Struct MediaType 

#[non_exhaustive]
pub struct MediaType {
    pub schema: Option<RefOr<Schema>>,
    pub example: Option<Value>,
    pub examples: BTreeMap<String, RefOr<Example>>,
    pub encoding: BTreeMap<String, Encoding>,
    pub extensions: Option<Extensions>,
}

Available on crate feature openapi and non-WebAssembly only.

Content holds request body content or response content.

Content implements OpenAPI spec Media Type Object

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

schema: Option<RefOr<Schema>>

Schema used in response body or request body.

example: Option<Value>

Example for request body or response body.

examples: BTreeMap<String, RefOr<Example>>

Examples of the request body or response body. Content::examples should match to media type and specified schema if present. Content::examples and Content::example are mutually exclusive. If both are defined examples will override value in example.

encoding: BTreeMap<String, Encoding>

A map between a property name and its encoding information.

The key, being 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.

extensions: Option<Extensions>

Optional extensions “x-something”.

Implementations

impl Content

pub fn builder() -> ContentBuilder

Available on crate feature rest only.

Construct a new ContentBuilder.

This is effectively same as calling ContentBuilder::new

impl Content

pub fn new<I>(schema: Option<I>) -> Content

where I: Into<RefOr<Schema>>,

Available on crate feature rest only.

Construct a new Content object for provided schema.

Trait Implementations

impl Clone for Content

fn clone(&self) -> Content

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Content

fn default() -> Content

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Content

fn deserialize<__D>( __deserializer: __D, ) -> Result<Content, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ContentBuilder> for Content

fn from(value: ContentBuilder) -> Content

Converts to this type from the input type.

impl From<Content> for ContentBuilder

fn from(value: Content) -> ContentBuilder

Converts to this type from the input type.

impl PartialEq for Content

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Content

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Content