Struct Example 

pub struct Example {
    pub reference: Option<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub value: Option<Value>,
    pub external_value: Option<String>,
}

Example value for a parameter, request body, or response.

Fields

reference: Option<String>

Reference to an example definition.

summary: Option<String>

Short summary of the example.

description: Option<String>

Long description of the example. CommonMark syntax may be used.

value: Option<Value>

Embedded literal example value.

external_value: Option<String>

URI pointing to an external 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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.