Struct utoipa::openapi::example::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() -> Self

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

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 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 From<Example> for ExampleBuilder

fn from(value: Example) -> Self

Converts to this type from the input type.

impl From<ExampleBuilder> for Example

fn from(value: ExampleBuilder) -> Self

Converts to this type from the input type.

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 Eq for Example

impl StructuralPartialEq for Example