Struct OpenApiExample 

pub struct OpenApiExample {
    pub summary: Option<String>,
    pub description: Option<String>,
    pub value: Value,
}

Named OpenAPI media example.

Fields

summary: Option<String>

description: Option<String>

value: Value

Implementations

impl OpenApiExample

pub fn value(value: Value) -> Self

pub fn try_value<T>(value: T) -> Result<Self>

where T: Serialize,

pub fn with_summary(self, summary: impl Into<String>) -> Self

pub fn with_description(self, description: impl Into<String>) -> Self

Trait Implementations

impl Clone for OpenApiExample

fn clone(&self) -> OpenApiExample

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenApiExample

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for OpenApiExample

fn eq(&self, other: &OpenApiExample) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for OpenApiExample

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 OpenApiExample