Struct ExternalDoc

pub struct ExternalDoc {
    pub url: Url,
    pub description: Option<String>,
}

Allows referencing an external resource for extended documentation.

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#externalDocumentationObject.

Fields

url: Url

The URL for the target documentation.

description: Option<String>

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

Trait Implementations

impl Clone for ExternalDoc

fn clone(&self) -> ExternalDoc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalDoc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExternalDoc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ExternalDoc

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

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 ExternalDoc