Struct TagBuilder

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

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

Implementations

impl<S: State> TagBuilder<S>

pub fn build(self) -> Tag

where S: IsComplete,

Finish building and return the requested object

pub fn name(self, value: impl Into<String>) -> TagBuilder<SetName<S>>

where S::Name: IsUnset,

Required.

Name of the tag. Should match to tag of operation.

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

where S::Description: IsUnset,

Optional (Some / Option setters).

Additional description for the tag shown in the document.

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

where S::Description: IsUnset,

Optional (Some / Option setters).

Additional description for the tag shown in the document.

pub fn external_docs( self, value: impl Into<ExternalDocs>, ) -> TagBuilder<SetExternalDocs<S>>

where S::ExternalDocs: IsUnset,

Optional (Some / Option setters).

Additional external documentation for the tag.

pub fn maybe_external_docs( self, value: Option<impl Into<ExternalDocs>>, ) -> TagBuilder<SetExternalDocs<S>>

where S::ExternalDocs: IsUnset,

Optional (Some / Option setters).

Additional external documentation for the tag.

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

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

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

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.