Enum Examples 

pub enum Examples {
    Inline(Value),
    Named(Map<RefOr<Example>>),
}

The examples an object shows its value with, in whichever form it uses.

A Parameter, Header or Media Type Object may carry one inline example or a map of named examples, and the specification makes the two mutually exclusive. An enum rather than two Option fields, for the reason SecurityScheme is one: an unusable combination that cannot be spelled needs no rule to reject it.

Note that the singular form is not an Example: example is the value itself, written inline, while examples maps names to Example Objects that can also carry a summary, a description or an external payload.

Variants

Inline(Value)

One example of the value, written to example.

Named(Map<RefOr<Example>>)

Named examples, written to examples.

Each is an Example or a reference to one in Components::examples.

Trait Implementations

impl Clone for Examples

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Examples

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

Formats the value using the given formatter.

impl PartialEq for Examples

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Examples