Struct utoipa::openapi::tag::Tag

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

Implements OpenAPI Tag Object.

Tag can be used to provide additional metadata for tags used by path operations.

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.

name: String

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

description: Option<String>

Additional description for the tag shown in the document.

external_docs: Option<ExternalDocs>

Additional external documentation for the tag.

Implementations

impl Tag

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

Construct a new Tag with given name.

Trait Implementations

impl Clone for Tag

fn clone(&self) -> Tag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Tag

fn default() -> Tag

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tag

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Tag> for TagBuilder

fn from(value: Tag) -> Self

Converts to this type from the input type.

impl From<TagBuilder> for Tag

fn from(value: TagBuilder) -> Self

Converts to this type from the input type.

impl PartialEq for Tag

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Tag

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 Tag

impl StructuralPartialEq for Tag