Struct ContentDescriptor

pub struct ContentDescriptor {
    pub name: String,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub required: bool,
    pub schema: Schema,
    pub deprecated: bool,
}

Content descriptors are that do just as they suggest - describe content. They are reusable ways of describing either parameters or results.

Fields

name: String

The name of the content being described.

If the content described is a method parameter assignable ByName, this field must be the name of the parameter.

summary: Option<String>

A short summary of the content that is being described.

description: Option<String>

A verbose explanation of the content being described.

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

required: bool

Determines if the content is a required field.

Default is false.

schema: Schema

A Schema that describes what is allowed in the content.

deprecated: bool

Whether the content is deprecated.

Default is false.

Trait Implementations

impl Clone for ContentDescriptor

fn clone(&self) -> ContentDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContentDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ContentDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ContentDescriptor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.