Struct utoipa::openapi::external_docs::ExternalDocs

#[non_exhaustive]
pub struct ExternalDocs {
    pub url: String,
    pub description: Option<String>,
}

Reference of external resource allowing extended documentation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

url: String

Target url for external documentation location.

description: Option<String>

Additional description supporting markdown syntax of the external documentation.

Implementations

impl ExternalDocs

pub fn new<S: AsRef<str>>(url: S) -> Self

Construct a new ExternalDocs.

Function takes target url argument for the external documentation location.

Examples

let external_docs = ExternalDocs::new("https://pet-api.external.docs");

Trait Implementations

impl Clone for ExternalDocs

fn clone(&self) -> ExternalDocs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ExternalDocs

fn default() -> ExternalDocs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExternalDocs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ExternalDocs> for ExternalDocsBuilder

fn from(value: ExternalDocs) -> Self

Converts to this type from the input type.

impl From<ExternalDocsBuilder> for ExternalDocs

fn from(value: ExternalDocsBuilder) -> Self

Converts to this type from the input type.

impl PartialEq for ExternalDocs

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ExternalDocs

impl StructuralPartialEq for ExternalDocs