Struct ExternalDocumentation 

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

A pointer to extended documentation.

Fields

description: Option<String>

A description of the target documentation. CommonMark syntax may be used.

url: String

The URI for the target documentation.

extensions: Extensions

Specification extensions.

Implementations

impl ExternalDocumentation

pub fn new(url: impl Into<String>) -> Self

Points at the given URI.

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

Sets the description.

Trait Implementations

impl Clone for ExternalDocumentation

fn clone(&self) -> Self

Returns a duplicate 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

Formats the value using the given formatter.

impl Default for ExternalDocumentation

fn default() -> Self

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ExternalDocumentation

impl PartialEq for ExternalDocumentation

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ExternalDocumentation

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 ExternalDocumentation