Struct Example

pub struct Example {
    pub summary: Cow<'static, str>,
    pub description: Cow<'static, str>,
    pub value: Option<ExampleValue>,
}

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#exampleObject.

Fields

summary: Cow<'static, str>

Short description for the example.

description: Cow<'static, str>

Long description for the example. CommonMark syntax MAY be used for rich text representation.

value: Option<ExampleValue>

Embedded literal example or a URL that points to the literal example.

Trait Implementations

impl Clone for Example

fn clone(&self) -> Example

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Example

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

Formats the value using the given formatter.

impl Default for Example

fn default() -> Example

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Example

fn deserialize<__D>( __deserializer: __D, ) -> Result<Example, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Example

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Example

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Example