Struct RequestBody 

#[non_exhaustive]
pub struct RequestBody {
    pub description: Option<String>,
    pub contents: IndexMap<String, Content>,
    pub required: Option<Required>,
}

Implements OpenAPI Request Body.

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.

description: Option<String>

Additional description of RequestBody supporting markdown syntax.

contents: IndexMap<String, Content>

Map of request body contents mapped by content type e.g. application/json.

required: Option<Required>

Determines whether request body is required in the request or not.

Implementations

impl RequestBody

pub fn new() -> RequestBody

Construct a new empty RequestBody. This is effectively same as calling RequestBody::default.

pub fn description<S>(self, description: S) -> RequestBody

where S: Into<String>,

Add description for RequestBody.

pub fn required(self, required: Required) -> RequestBody

Define RequestBody required.

pub fn add_content<S, C>(self, kind: S, content: C) -> RequestBody

where S: Into<String>, C: Into<Content>,

Add Content by content type e.g application/json to RequestBody.

pub fn merge(&mut self, other: RequestBody)

Fill RequestBody with values from another RequestBody.

Trait Implementations

impl Clone for RequestBody

fn clone(&self) -> RequestBody

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<(), Error>

Formats the value using the given formatter.

impl Default for RequestBody

fn default() -> RequestBody

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RequestBody

fn eq(&self, other: &RequestBody) -> 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 RequestBody

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 RequestBody