Struct Example

#[non_exhaustive]
pub struct Example {
    pub summary: String,
    pub description: String,
    pub value: Option<Value>,
    pub external_value: String,
}

Implements OpenAPI Example Object.

Example is used on path operations to describe possible response bodies.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

summary: String

Short description for the Example.

description: String

Long description for the Example. Value supports markdown syntax for rich text representation.

value: Option<Value>

Embedded literal example value. Example::value and Example::external_value are mutually exclusive.

external_value: String

An URI that points to a literal example value. Example::external_value provides the capability to references an example that cannot be easily included in JSON or YAML. Example::value and Example::external_value are mutually exclusive.

Implementations

impl Example

pub fn new() -> Example

Construct a new empty Example. This is effectively same as calling Example::default.

pub fn summary<S>(self, summary: S) -> Example

where S: Into<String>,

Add or change a short description for the Example. Setting this to empty String will make it not render in the generated OpenAPI document.

pub fn description<D>(self, description: D) -> Example

where D: Into<String>,

Add or change a long description for the Example. Markdown syntax is supported for rich text representation.

Setting this to empty String will make it not render in the generated OpenAPI document.

pub fn value(self, value: Value) -> Example

Add or change embedded literal example value. Example::value and Example::external_value are mutually exclusive.

pub fn external_value<E>(self, external_value: E) -> Example

where E: Into<String>,

Add or change an URI that points to a literal example value. Example::external_value provides the capability to references an example that cannot be easily included in JSON or YAML. Example::value and Example::external_value are mutually exclusive.

Setting this to an empty String will make the field not to render in the generated OpenAPI document.

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<(), 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 Eq for Example

impl StructuralPartialEq for Example