Struct oas3::MediaType

pub struct MediaType {
    pub schema: Option<ObjectOrReference<Schema>>,
    pub examples: Option<MediaTypeExamples>,
    pub encoding: BTreeMap<String, Encoding>,
}

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

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#media-type-object.

Fields

schema: Option<ObjectOrReference<Schema>>

The schema defining the type used for the request body.

examples: Option<MediaTypeExamples>

Example of the media type.

encoding: BTreeMap<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.

Methods

impl MediaType

pub fn get_schema(&self, spec: &Spec) -> Option<Schema>

pub fn get_examples(&self, spec: &Spec) -> BTreeMap<String, Example>

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 Default for MediaType

fn default() -> MediaType

Returns the "default value" for a type.

impl PartialEq<MediaType> 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: &MediaType) -> bool

This method tests for !=.

impl Debug for MediaType

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

Formats the value using the given formatter.

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<'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.