Struct utoipa::openapi::request_body::RequestBody

#[non_exhaustive]
pub struct RequestBody {
    pub description: Option<String>,
    pub content: BTreeMap<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.

content: BTreeMap<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() -> Self

Construct a new RequestBody.

Trait Implementations

impl Clone for RequestBody

fn clone(&self) -> RequestBody

Returns a copy of the value.

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

Performs copy-assignment from source.

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<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RequestBody> for RequestBodyBuilder

fn from(value: RequestBody) -> Self

Converts to this type from the input type.

impl From<RequestBodyBuilder> for RequestBody

fn from(value: RequestBodyBuilder) -> Self

Converts to this type from the input type.

impl PartialEq<RequestBody> for RequestBody

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

fn json_schema_ref(self, ref_name: &str) -> RequestBody

Available on crate feature openapi_extensions only.

Add Content to RequestBody referring to a schema with Content-Type application/json.

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