Struct RequestBody 

pub struct RequestBody {
    pub description: Option<String>,
    pub content: Map<MediaType>,
    pub required: Option<bool>,
    pub extensions: Extensions,
}

A request body.

Fields

description: Option<String>

A description of the body. CommonMark syntax may be used.

content: Map<MediaType>

The body’s representations, keyed by media type or media type range.

More than one entry describes a body the server accepts in several encodings.

required: Option<bool>

Whether the body is mandatory. Defaults to false.

extensions: Extensions

Specification extensions.

Implementations

impl RequestBody

pub fn new(media_type: impl Into<String>, content: MediaType) -> Self

Creates a required body with a single media type.

pub fn json(schema: Schema) -> Self

Creates a required application/json body.

pub fn with_media_type( self, media_type: impl Into<String>, content: MediaType, ) -> Self

Adds another representation of the same body.

pub fn optional(self) -> Self

Marks the body optional.

pub fn with_description(self, description: impl Into<String>) -> Self

Sets the description.

Trait Implementations

impl Clone for RequestBody

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestBody

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

Formats the value using the given formatter.

impl Default for RequestBody

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RequestBody

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RequestBody

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RequestBody

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 RequestBody