Struct openapiv3::MediaType

pub struct MediaType {
    pub schema: Option<ReferenceOr<Schema>>,
    pub example: Option<Value>,
    pub examples: IndexMap<String, ReferenceOr<Example>>,
    pub encoding: IndexMap<String, Encoding>,
    pub extensions: IndexMap<String, Value>,
}

Each Media Type Object provides schema and examples for the media type identified by its key.

Fields

schema: Option<ReferenceOr<Schema>>

The schema defining the content of the request, response, or parameter.

example: Option<Value>

Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema.

examples: IndexMap<String, ReferenceOr<Example>>

Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema.

encoding: IndexMap<String, Encoding>

A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded.

extensions: IndexMap<String, Value>

Inline extensions to this object.

Trait Implementations

impl Clone for MediaType

fn clone(&self) -> MediaType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MediaType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MediaType

fn default() -> MediaType

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MediaType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MediaType

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for MediaType

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MediaType