Struct utoipa::openapi::external_docs::ExternalDocsBuilder

pub struct ExternalDocsBuilder { /* private fields */ }

Builder for ExternalDocs with chainable configuration methods to create a new ExternalDocs.

Implementations

impl ExternalDocsBuilder

pub fn new() -> ExternalDocsBuilder

Constructs a new ExternalDocsBuilder.

pub fn build(self) -> ExternalDocs

Constructs a new ExternalDocs taking all fields values from this object.

impl ExternalDocsBuilder

pub fn url<I: Into<String>>(self, url: I) -> Self

Add target url for external documentation location.

pub fn description<S: Into<String>>(self, description: Option<S>) -> Self

Add additional description of external documentation.

Trait Implementations

impl Default for ExternalDocsBuilder

fn default() -> Self

Returns the “default value” for a type.

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.