Struct ExternalDocumentation

pub struct ExternalDocumentation {
    pub description: Option<String>,
    pub url: String,
    pub extensions: IndexMap<String, Value>,
}

Allows referencing an external resource for extended documentation.

Fields

description: Option<String>

A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.

url: String

REQUIRED. The URL for the target documentation. Value MUST be in the format of a URL.

extensions: IndexMap<String, Value>

Inline extensions to this object.

Trait Implementations

impl Clone for ExternalDocumentation

fn clone(&self) -> ExternalDocumentation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalDocumentation

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

Formats the value using the given formatter.

impl Default for ExternalDocumentation

fn default() -> ExternalDocumentation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExternalDocumentation

fn deserialize<__D>( __deserializer: __D, ) -> Result<ExternalDocumentation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ExternalDocumentation

fn eq(&self, other: &ExternalDocumentation) -> 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 ExternalDocumentation

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 StructuralPartialEq for ExternalDocumentation