Struct Example 

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

Multi-purpose example objects.

Will be validated against schema when used in conformance testing.

See https://spec.openapis.org/oas/v3.1.1#example-object.

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: Option<Value>

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: BTreeMap<String, Value>

Specification extensions.

Only “x-” prefixed keys are collected, and the prefix is stripped.

See https://spec.openapis.org/oas/v3.1.1#specification-extensions.

Implementations

impl Example

pub fn as_bytes(&self) -> Vec<u8>

Returns JSON-encoded bytes of this example’s value.

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 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<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromRef for Example

fn from_ref(spec: &Spec, path: &str) -> Result<Self, RefError>

Finds an object in spec using the given path.

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Example