Struct salvo_oapi::Content

#[non_exhaustive]
pub struct Content {
    pub schema: RefOr<Schema>,
    pub example: Option<Value>,
    pub examples: BTreeMap<String, RefOr<Example>>,
    pub encoding: BTreeMap<String, Encoding>,
}

Content holds request body content or response content.

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.

schema: RefOr<Schema>

Schema used in response body or request body.

example: Option<Value>

Example for request body or response body.

examples: BTreeMap<String, RefOr<Example>>

Examples of the request body or response body. Content::examples should match to media type and specified schema if present. Content::examples and Content::example are mutually exclusive. If both are defined examples will override value in example.

encoding: BTreeMap<String, Encoding>

A map between a property name and its encoding information.

The key, being the property name, MUST exist in the Content::schema as a property, with schema being a Schema::Object and this object containing the same property key in Object::properties.

The encoding object SHALL only apply to request_body objects when the media type is multipart or application/x-www-form-urlencoded.

Implementations

impl Content

pub fn new<I: Into<RefOr<Schema>>>(schema: I) -> Self

Construct a new Content.

pub fn schema<I: Into<RefOr<Schema>>>(self, component: I) -> Self

Add schema.

pub fn example(self, example: Value) -> Self

Add example of schema.

pub fn extend_examples<E: IntoIterator<Item = (N, V)>, N: Into<String>, V: Into<RefOr<Example>>>( self, examples: E, ) -> Self

Add iterator of (N, V) where N is name of example and V is Example to Content of a request body or response body.

Content::examples and Content::example are mutually exclusive. If both are defined examples will override value in example.

pub fn encoding<S: Into<String>, E: Into<Encoding>>( self, property_name: S, encoding: E, ) -> Self

Add an encoding.

The property_name MUST exist in the Content::schema as a property, with schema being a Schema::Object and this object containing the same property key in Object::properties.

The encoding object SHALL only apply to request_body objects when the media type is multipart or application/x-www-form-urlencoded.

Trait Implementations

impl Clone for Content

fn clone(&self) -> Content

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Content

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

Formats the value using the given formatter.

impl Default for Content

fn default() -> Content

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Content

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RefOr<Schema>> for Content

fn from(schema: RefOr<Schema>) -> Self

Converts to this type from the input type.

impl PartialEq for Content

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

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 Content