Struct utoipa::openapi::response::Responses

#[non_exhaustive]
pub struct Responses {
    pub responses: BTreeMap<String, RefOr<Response>>,
}

Implements OpenAPI Responses Object.

Responses is a map holding api operation responses identified by their status code.

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.

responses: BTreeMap<String, RefOr<Response>>

Map containing status code as a key with represented response as a value.

Implementations

impl Responses

pub fn new() -> Self

Trait Implementations

impl Clone for Responses

fn clone(&self) -> Responses

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Responses

fn default() -> Responses

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Responses

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Responses> for BTreeMap<String, RefOr<Response>>

fn from(responses: Responses) -> Self

Converts to this type from the input type.

impl From<Responses> for ResponsesBuilder

fn from(value: Responses) -> Self

Converts to this type from the input type.

impl From<ResponsesBuilder> for Responses

fn from(value: ResponsesBuilder) -> Self

Converts to this type from the input type.

impl<C, R> FromIterator<(C, R)> for Responses

where C: Into<String>, R: Into<RefOr<Response>>,

fn from_iter<T: IntoIterator<Item = (C, R)>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq for Responses

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

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 Responses