Struct ExampleObject

pub struct ExampleObject {
    pub name: Option<String>,
    pub description: Option<String>,
    pub summary: Option<String>,
    pub value: Option<ExampleValue>,
}

Defines an example that is intended to match a Schema of a given ContentDescriptor.

Fields

name: Option<String>

Cannonical name of the example.

description: Option<String>

A verbose description of the example

GitHub Flavored Markdown syntax may be used for rich text representation.

summary: Option<String>

A short summary of the example.

value: Option<ExampleValue>

The value of the example.

Trait Implementations

impl Clone for ExampleObject

fn clone(&self) -> ExampleObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExampleObject

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

Formats the value using the given formatter.

impl Default for ExampleObject

fn default() -> ExampleObject

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExampleObject

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ExampleObject

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.