Enum jsdoc::ast::Tag

#[non_exhaustive]
pub enum Tag {
    Yield(YieldTag),
    TypeDef(TypeDefTag),
    Throw(ThrowTag),
    Todo(TodoTag),
    Tutorial(TutorialTag),
    Static(StaticTag),
    Summary(SummaryTag),
    See(SeeTag),
    Since(SinceTag),
    Requires(RequiresTag),
    Override(OverrideTag),
    Package(PackageTag),
    Module(ModuleTag),
    Name(NameTag),
    Namespace(NamespaceTag),
    Variation(VariationTag),
    Version(VersionTag),
    MemberOf(MemberOfTag),
    Mixes(MixesTag),
    Mixin(MixinTag),
    Member(MemberTag),
    Listens(ListensTag),
    License(LicenseTag),
    Kind(KindTag),
    Lends(LendsTag),
    Instance(InstanceTag),
    Interface(InterfaceTag),
    Inner(InnerTag),
    InheritDoc(InheritDocTag),
    Ignore(IgnoreTag),
    HideConstructor(HideConstructorTag),
    Generator(GeneratorTag),
    Function(FunctionTag),
    File(FilelTag),
    Constructs(ConstructsTag),
    Copyright(CopyrightTag),
    Abstract(AbstractTag),
    Access(AccessTag),
    Alias(AliasTag),
    Async(AsyncTag),
    Unknown(UnknownTag),
    Augments(AugmentsTag),
    Implements(ImplementsTag),
    Author(AuthorTag),
    Borrows(BorrowsTag),
    Class(ClassTag),
    ClassDesc(JSDocClassDescTag),
    Const(ConstTag),
    Public(PublicTag),
    Private(PrivateTag),
    Protected(ProtectedTag),
    Readonly(ReadonlyTag),
    Callback(CallbackTag),
    Enum(EnumTag),
    Parameter(ParameterTag),
    Return(ReturnTag),
    This(ThisTag),
    Type(TypeTag),
    Template(TemplateTag),
    Typedef(TypedefTag),
    Property(PropertyTag),
    Description(DescriptionTag),
    Example(ExampleTag),
    Exports(ExportsTag),
    External(ExternalTag),
    Default(DefaultTag),
    Deprecated(DeprecatedTag),
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Yield(YieldTag)

Tuple Fields of Yield

0: YieldTag

TypeDef(TypeDefTag)

Tuple Fields of TypeDef

0: TypeDefTag

Throw(ThrowTag)

Tuple Fields of Throw

0: ThrowTag

Todo(TodoTag)

Tuple Fields of Todo

0: TodoTag

Tutorial(TutorialTag)

Tuple Fields of Tutorial

0: TutorialTag

Static(StaticTag)

Tuple Fields of Static

0: StaticTag

Summary(SummaryTag)

Tuple Fields of Summary

0: SummaryTag

See(SeeTag)

Tuple Fields of See

0: SeeTag

Since(SinceTag)

Tuple Fields of Since

0: SinceTag

Requires(RequiresTag)

Tuple Fields of Requires

0: RequiresTag

Override(OverrideTag)

Tuple Fields of Override

0: OverrideTag

Package(PackageTag)

Tuple Fields of Package

0: PackageTag

Module(ModuleTag)

Tuple Fields of Module

0: ModuleTag

Name(NameTag)

Tuple Fields of Name

0: NameTag

Namespace(NamespaceTag)

Tuple Fields of Namespace

0: NamespaceTag

Variation(VariationTag)

Tuple Fields of Variation

0: VariationTag

Version(VersionTag)

Tuple Fields of Version

0: VersionTag

MemberOf(MemberOfTag)

Tuple Fields of MemberOf

0: MemberOfTag

Mixes(MixesTag)

Tuple Fields of Mixes

0: MixesTag

Mixin(MixinTag)

Tuple Fields of Mixin

0: MixinTag

Member(MemberTag)

Tuple Fields of Member

0: MemberTag

Listens(ListensTag)

Tuple Fields of Listens

0: ListensTag

License(LicenseTag)

Tuple Fields of License

0: LicenseTag

Kind(KindTag)

Tuple Fields of Kind

0: KindTag

Lends(LendsTag)

Tuple Fields of Lends

0: LendsTag

Instance(InstanceTag)

Tuple Fields of Instance

0: InstanceTag

Interface(InterfaceTag)

Tuple Fields of Interface

0: InterfaceTag

Inner(InnerTag)

Tuple Fields of Inner

0: InnerTag

InheritDoc(InheritDocTag)

Tuple Fields of InheritDoc

0: InheritDocTag

Ignore(IgnoreTag)

Tuple Fields of Ignore

0: IgnoreTag

HideConstructor(HideConstructorTag)

Tuple Fields of HideConstructor

0: HideConstructorTag

Generator(GeneratorTag)

Tuple Fields of Generator

0: GeneratorTag

Function(FunctionTag)

Tuple Fields of Function

0: FunctionTag

File(FilelTag)

Tuple Fields of File

0: FilelTag

Constructs(ConstructsTag)

Tuple Fields of Constructs

0: ConstructsTag

Copyright(CopyrightTag)

Tuple Fields of Copyright

0: CopyrightTag

Abstract(AbstractTag)

Tuple Fields of Abstract

0: AbstractTag

Access(AccessTag)

Tuple Fields of Access

0: AccessTag

Alias(AliasTag)

Tuple Fields of Alias

0: AliasTag

Async(AsyncTag)

Tuple Fields of Async

0: AsyncTag

Unknown(UnknownTag)

Tuple Fields of Unknown

0: UnknownTag

Augments(AugmentsTag)

Tuple Fields of Augments

0: AugmentsTag

Implements(ImplementsTag)

Tuple Fields of Implements

0: ImplementsTag

Author(AuthorTag)

Tuple Fields of Author

0: AuthorTag

Borrows(BorrowsTag)

Tuple Fields of Borrows

0: BorrowsTag

Class(ClassTag)

Tuple Fields of Class

0: ClassTag

ClassDesc(JSDocClassDescTag)

Tuple Fields of ClassDesc

0: JSDocClassDescTag

Const(ConstTag)

Tuple Fields of Const

0: ConstTag

Public(PublicTag)

Tuple Fields of Public

0: PublicTag

Private(PrivateTag)

Tuple Fields of Private

0: PrivateTag

Protected(ProtectedTag)

Tuple Fields of Protected

0: ProtectedTag

Readonly(ReadonlyTag)

Tuple Fields of Readonly

0: ReadonlyTag

Callback(CallbackTag)

Tuple Fields of Callback

0: CallbackTag

Enum(EnumTag)

Tuple Fields of Enum

0: EnumTag

Parameter(ParameterTag)

Tuple Fields of Parameter

0: ParameterTag

Return(ReturnTag)

Tuple Fields of Return

0: ReturnTag

This(ThisTag)

Tuple Fields of This

0: ThisTag

Type(TypeTag)

Tuple Fields of Type

0: TypeTag

Template(TemplateTag)

Tuple Fields of Template

0: TemplateTag

Typedef(TypedefTag)

Tuple Fields of Typedef

0: TypedefTag

Property(PropertyTag)

Tuple Fields of Property

0: PropertyTag

Description(DescriptionTag)

Tuple Fields of Description

0: DescriptionTag

Example(ExampleTag)

Tuple Fields of Example

0: ExampleTag

Exports(ExportsTag)

Tuple Fields of Exports

0: ExportsTag

External(ExternalTag)

Tuple Fields of External

0: ExternalTag

Default(DefaultTag)

Tuple Fields of Default

0: DefaultTag

Deprecated(DeprecatedTag)

Tuple Fields of Deprecated

0: DeprecatedTag

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 Debug for Tag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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<AbstractTag> for Tag

fn from(v: AbstractTag) -> Self

Performs the conversion.

impl From<AccessTag> for Tag

fn from(v: AccessTag) -> Self

Performs the conversion.

impl From<AliasTag> for Tag

fn from(v: AliasTag) -> Self

Performs the conversion.

impl From<AsyncTag> for Tag

fn from(v: AsyncTag) -> Self

Performs the conversion.

impl From<AugmentsTag> for Tag

fn from(v: AugmentsTag) -> Self

Performs the conversion.

impl From<AuthorTag> for Tag

fn from(v: AuthorTag) -> Self

Performs the conversion.

impl From<BorrowsTag> for Tag

fn from(v: BorrowsTag) -> Self

Performs the conversion.

impl From<CallbackTag> for Tag

fn from(v: CallbackTag) -> Self

Performs the conversion.

impl From<ClassTag> for Tag

fn from(v: ClassTag) -> Self

Performs the conversion.

impl From<ConstTag> for Tag

fn from(v: ConstTag) -> Self

Performs the conversion.

impl From<ConstructsTag> for Tag

fn from(v: ConstructsTag) -> Self

Performs the conversion.

impl From<CopyrightTag> for Tag

fn from(v: CopyrightTag) -> Self

Performs the conversion.

impl From<DefaultTag> for Tag

fn from(v: DefaultTag) -> Self

Performs the conversion.

impl From<DeprecatedTag> for Tag

fn from(v: DeprecatedTag) -> Self

Performs the conversion.

impl From<DescriptionTag> for Tag

fn from(v: DescriptionTag) -> Self

Performs the conversion.

impl From<EnumTag> for Tag

fn from(v: EnumTag) -> Self

Performs the conversion.

impl From<ExampleTag> for Tag

fn from(v: ExampleTag) -> Self

Performs the conversion.

impl From<ExportsTag> for Tag

fn from(v: ExportsTag) -> Self

Performs the conversion.

impl From<ExternalTag> for Tag

fn from(v: ExternalTag) -> Self

Performs the conversion.

impl From<FilelTag> for Tag

fn from(v: FilelTag) -> Self

Performs the conversion.

impl From<FunctionTag> for Tag

fn from(v: FunctionTag) -> Self

Performs the conversion.

impl From<GeneratorTag> for Tag

fn from(v: GeneratorTag) -> Self

Performs the conversion.

impl From<HideConstructorTag> for Tag

fn from(v: HideConstructorTag) -> Self

Performs the conversion.

impl From<IgnoreTag> for Tag

fn from(v: IgnoreTag) -> Self

Performs the conversion.

impl From<ImplementsTag> for Tag

fn from(v: ImplementsTag) -> Self

Performs the conversion.

impl From<InheritDocTag> for Tag

fn from(v: InheritDocTag) -> Self

Performs the conversion.

impl From<InnerTag> for Tag

fn from(v: InnerTag) -> Self

Performs the conversion.

impl From<InstanceTag> for Tag

fn from(v: InstanceTag) -> Self

Performs the conversion.

impl From<InterfaceTag> for Tag

fn from(v: InterfaceTag) -> Self

Performs the conversion.

impl From<JSDocClassDescTag> for Tag

fn from(v: JSDocClassDescTag) -> Self

Performs the conversion.

impl From<KindTag> for Tag

fn from(v: KindTag) -> Self

Performs the conversion.

impl From<LendsTag> for Tag

fn from(v: LendsTag) -> Self

Performs the conversion.

impl From<LicenseTag> for Tag

fn from(v: LicenseTag) -> Self

Performs the conversion.

impl From<ListensTag> for Tag

fn from(v: ListensTag) -> Self

Performs the conversion.

impl From<MemberOfTag> for Tag

fn from(v: MemberOfTag) -> Self

Performs the conversion.

impl From<MemberTag> for Tag

fn from(v: MemberTag) -> Self

Performs the conversion.

impl From<MixesTag> for Tag

fn from(v: MixesTag) -> Self

Performs the conversion.

impl From<MixinTag> for Tag

fn from(v: MixinTag) -> Self

Performs the conversion.

impl From<ModuleTag> for Tag

fn from(v: ModuleTag) -> Self

Performs the conversion.

impl From<NameTag> for Tag

fn from(v: NameTag) -> Self

Performs the conversion.

impl From<NamespaceTag> for Tag

fn from(v: NamespaceTag) -> Self

Performs the conversion.

impl From<OverrideTag> for Tag

fn from(v: OverrideTag) -> Self

Performs the conversion.

impl From<PackageTag> for Tag

fn from(v: PackageTag) -> Self

Performs the conversion.

impl From<ParameterTag> for Tag

fn from(v: ParameterTag) -> Self

Performs the conversion.

impl From<PrivateTag> for Tag

fn from(v: PrivateTag) -> Self

Performs the conversion.

impl From<PropertyTag> for Tag

fn from(v: PropertyTag) -> Self

Performs the conversion.

impl From<ProtectedTag> for Tag

fn from(v: ProtectedTag) -> Self

Performs the conversion.

impl From<PublicTag> for Tag

fn from(v: PublicTag) -> Self

Performs the conversion.

impl From<ReadonlyTag> for Tag

fn from(v: ReadonlyTag) -> Self

Performs the conversion.

impl From<RequiresTag> for Tag

fn from(v: RequiresTag) -> Self

Performs the conversion.

impl From<ReturnTag> for Tag

fn from(v: ReturnTag) -> Self

Performs the conversion.

impl From<SeeTag> for Tag

fn from(v: SeeTag) -> Self

Performs the conversion.

impl From<SinceTag> for Tag

fn from(v: SinceTag) -> Self

Performs the conversion.

impl From<StaticTag> for Tag

fn from(v: StaticTag) -> Self

Performs the conversion.

impl From<SummaryTag> for Tag

fn from(v: SummaryTag) -> Self

Performs the conversion.

impl From<TemplateTag> for Tag

fn from(v: TemplateTag) -> Self

Performs the conversion.

impl From<ThisTag> for Tag

fn from(v: ThisTag) -> Self

Performs the conversion.

impl From<ThrowTag> for Tag

fn from(v: ThrowTag) -> Self

Performs the conversion.

impl From<TodoTag> for Tag

fn from(v: TodoTag) -> Self

Performs the conversion.

impl From<TutorialTag> for Tag

fn from(v: TutorialTag) -> Self

Performs the conversion.

impl From<TypeDefTag> for Tag

fn from(v: TypeDefTag) -> Self

Performs the conversion.

impl From<TypeTag> for Tag

fn from(v: TypeTag) -> Self

Performs the conversion.

impl From<TypedefTag> for Tag

fn from(v: TypedefTag) -> Self

Performs the conversion.

impl From<UnknownTag> for Tag

fn from(v: UnknownTag) -> Self

Performs the conversion.

impl From<VariationTag> for Tag

fn from(v: VariationTag) -> Self

Performs the conversion.

impl From<VersionTag> for Tag

fn from(v: VersionTag) -> Self

Performs the conversion.

impl From<YieldTag> for Tag

fn from(v: YieldTag) -> Self

Performs the conversion.

impl PartialEq<Tag> 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: &Tag) -> bool

This method tests for !=.

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 Spanned for Tag

fn span(&self) -> Span

Get span of self.

impl StructuralPartialEq for Tag