Struct ExternalDocsBuilder

pub struct ExternalDocsBuilder<S: State = Empty> { /* private fields */ }

Use builder syntax to set the inputs and finish with build().

Implementations

impl<S: State> ExternalDocsBuilder<S>

pub fn build(self) -> ExternalDocs

where S: IsComplete,

Finish building and return the requested object

pub fn url(self, value: impl Into<String>) -> ExternalDocsBuilder<SetUrl<S>>

where S::Url: IsUnset,

Required.

Target url for external documentation location.

pub fn description( self, value: impl Into<String>, ) -> ExternalDocsBuilder<SetDescription<S>>

where S::Description: IsUnset,

Optional (Some / Option setters).

Additional description supporting markdown syntax of the external documentation.

pub fn maybe_description( self, value: Option<impl Into<String>>, ) -> ExternalDocsBuilder<SetDescription<S>>

where S::Description: IsUnset,

Optional (Some / Option setters).

Additional description supporting markdown syntax of the external documentation.

pub fn extensions( self, value: impl Into<Extensions>, ) -> ExternalDocsBuilder<SetExtensions<S>>

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

pub fn maybe_extensions( self, value: Option<impl Into<Extensions>>, ) -> ExternalDocsBuilder<SetExtensions<S>>

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

Trait Implementations

impl<S: IsComplete> From<ExternalDocsBuilder<S>> for ExternalDocs

fn from(builder: ExternalDocsBuilder<S>) -> Self

Converts to this type from the input type.