Struct Responses 

pub struct Responses {
    pub default_response: Option<RefOr<Response>>,
    pub responses: Map<RefOr<Response>>,
    pub extensions: Extensions,
}

The responses an operation may return.

Serializes with default_response under the default key, each entry of responses under its status pattern, and extensions alongside them.

Fields

default_response: Option<RefOr<Response>>

The response used for status codes not otherwise covered.

responses: Map<RefOr<Response>>

Responses keyed by status code or wildcard.

extensions: Extensions

Specification extensions.

Implementations

impl Responses

pub fn new() -> Self

Creates an empty set of responses.

A description must not keep it empty: the specification requires at least one response, and crate::validate reports the omission.

pub fn with(self, status: u16, response: Response) -> Self

Declares a response for an exact status code.

pub fn with_pattern( self, pattern: StatusPattern, response: RefOr<Response>, ) -> Self

Declares a response for a status pattern.

pub fn with_default(self, response: Response) -> Self

Sets the fallback response.

pub fn is_empty(&self) -> bool

Returns true when nothing at all is declared.

Extensions count. Operation.responses is skipped when this is true, so ignoring them would silently drop a Responses that carries only x- fields — which is exactly the drop a round trip must not make.

This is therefore not the question the specification’s “MUST contain at least one response code” asks. declares_a_response is.

pub fn declares_a_response(&self) -> bool

Returns true when a status code or default is declared.

The distinction from is_empty is the whole point: an extension is not a response, so a Responses Object carrying only x- fields is not empty and still declares nothing.

pub fn get(&self, status: u16) -> Option<&RefOr<Response>>

Looks up the response declared for an exact status code.

Only exact keys are considered; wildcard resolution is a consumer concern and depends on precedence rules this method does not apply.

pub fn merge_from(&mut self, other: &Self)

Merges another set into this one, keeping existing entries on conflict.

This is how an interceptor’s declared responses join an operation’s own.

Trait Implementations

impl Clone for Responses

fn clone(&self) -> Responses

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Responses

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

Formats the value using the given formatter.

impl Default for Responses

fn default() -> Responses

Returns the “default value” for a type.

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

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for Responses

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Responses

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Responses