Struct Example

pub struct Example {
    pub summary: Option<String>,
    pub description: Option<String>,
    pub value: ExampleValue,
    pub extensions: IndexMap<String, Value>,
}

Fields

summary: Option<String>

Short description for the example.

description: Option<String>

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

value: ExampleValue

Embedded literal example. The value field and `externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.

extensions: IndexMap<String, Value>

This object MAY be extended with Specification Extensions.

Trait Implementations

impl Clone for Example

fn clone(&self) -> Example

Returns a copy 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

Formats the value using the given formatter.

impl Serialize for Example

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

where __S: Serializer,

Serialize this value into the given Serde serializer.