Enum jsdoc::ast::Tag

#[non_exhaustive]
pub enum Tag {
Show 67 variants
    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(FileTag),
    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)§

This enum is marked as 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)

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(FileTag)

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)

Trait Implementations§

impl Clone for Tag

fn clone(&self) -> Tag

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Tag

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

Formats the value using the given formatter. Read more

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. Read more

impl From<AbstractTag> for Tag

fn from(v: AbstractTag) -> Self

Converts to this type from the input type.

impl From<AccessTag> for Tag

fn from(v: AccessTag) -> Self

Converts to this type from the input type.

impl From<AliasTag> for Tag

fn from(v: AliasTag) -> Self

Converts to this type from the input type.

impl From<AsyncTag> for Tag

fn from(v: AsyncTag) -> Self

Converts to this type from the input type.

impl From<AugmentsTag> for Tag

fn from(v: AugmentsTag) -> Self

Converts to this type from the input type.

impl From<AuthorTag> for Tag

fn from(v: AuthorTag) -> Self

Converts to this type from the input type.

impl From<BorrowsTag> for Tag

fn from(v: BorrowsTag) -> Self

Converts to this type from the input type.

impl From<CallbackTag> for Tag

fn from(v: CallbackTag) -> Self

Converts to this type from the input type.

impl From<ClassTag> for Tag

fn from(v: ClassTag) -> Self

Converts to this type from the input type.

impl From<ConstTag> for Tag

fn from(v: ConstTag) -> Self

Converts to this type from the input type.

impl From<ConstructsTag> for Tag

fn from(v: ConstructsTag) -> Self

Converts to this type from the input type.

impl From<CopyrightTag> for Tag

fn from(v: CopyrightTag) -> Self

Converts to this type from the input type.

impl From<DefaultTag> for Tag

fn from(v: DefaultTag) -> Self

Converts to this type from the input type.

impl From<DeprecatedTag> for Tag

fn from(v: DeprecatedTag) -> Self

Converts to this type from the input type.

impl From<DescriptionTag> for Tag

fn from(v: DescriptionTag) -> Self

Converts to this type from the input type.

impl From<EnumTag> for Tag

fn from(v: EnumTag) -> Self

Converts to this type from the input type.

impl From<ExampleTag> for Tag

fn from(v: ExampleTag) -> Self

Converts to this type from the input type.

impl From<ExportsTag> for Tag

fn from(v: ExportsTag) -> Self

Converts to this type from the input type.

impl From<ExternalTag> for Tag

fn from(v: ExternalTag) -> Self

Converts to this type from the input type.

impl From<FileTag> for Tag

fn from(v: FileTag) -> Self

Converts to this type from the input type.

impl From<FunctionTag> for Tag

fn from(v: FunctionTag) -> Self

Converts to this type from the input type.

impl From<GeneratorTag> for Tag

fn from(v: GeneratorTag) -> Self

Converts to this type from the input type.

impl From<HideConstructorTag> for Tag

fn from(v: HideConstructorTag) -> Self

Converts to this type from the input type.

impl From<IgnoreTag> for Tag

fn from(v: IgnoreTag) -> Self

Converts to this type from the input type.

impl From<ImplementsTag> for Tag

fn from(v: ImplementsTag) -> Self

Converts to this type from the input type.

impl From<InheritDocTag> for Tag

fn from(v: InheritDocTag) -> Self

Converts to this type from the input type.

impl From<InnerTag> for Tag

fn from(v: InnerTag) -> Self

Converts to this type from the input type.

impl From<InstanceTag> for Tag

fn from(v: InstanceTag) -> Self

Converts to this type from the input type.

impl From<InterfaceTag> for Tag

fn from(v: InterfaceTag) -> Self

Converts to this type from the input type.

impl From<JSDocClassDescTag> for Tag

fn from(v: JSDocClassDescTag) -> Self

Converts to this type from the input type.

impl From<KindTag> for Tag

fn from(v: KindTag) -> Self

Converts to this type from the input type.

impl From<LendsTag> for Tag

fn from(v: LendsTag) -> Self

Converts to this type from the input type.

impl From<LicenseTag> for Tag

fn from(v: LicenseTag) -> Self

Converts to this type from the input type.

impl From<ListensTag> for Tag

fn from(v: ListensTag) -> Self

Converts to this type from the input type.

impl From<MemberOfTag> for Tag

fn from(v: MemberOfTag) -> Self

Converts to this type from the input type.

impl From<MemberTag> for Tag

fn from(v: MemberTag) -> Self

Converts to this type from the input type.

impl From<MixesTag> for Tag

fn from(v: MixesTag) -> Self

Converts to this type from the input type.

impl From<MixinTag> for Tag

fn from(v: MixinTag) -> Self

Converts to this type from the input type.

impl From<ModuleTag> for Tag

fn from(v: ModuleTag) -> Self

Converts to this type from the input type.

impl From<NameTag> for Tag

fn from(v: NameTag) -> Self

Converts to this type from the input type.

impl From<NamespaceTag> for Tag

fn from(v: NamespaceTag) -> Self

Converts to this type from the input type.

impl From<OverrideTag> for Tag

fn from(v: OverrideTag) -> Self

Converts to this type from the input type.

impl From<PackageTag> for Tag

fn from(v: PackageTag) -> Self

Converts to this type from the input type.

impl From<ParameterTag> for Tag

fn from(v: ParameterTag) -> Self

Converts to this type from the input type.

impl From<PrivateTag> for Tag

fn from(v: PrivateTag) -> Self

Converts to this type from the input type.

impl From<PropertyTag> for Tag

fn from(v: PropertyTag) -> Self

Converts to this type from the input type.

impl From<ProtectedTag> for Tag

fn from(v: ProtectedTag) -> Self

Converts to this type from the input type.

impl From<PublicTag> for Tag

fn from(v: PublicTag) -> Self

Converts to this type from the input type.

impl From<ReadonlyTag> for Tag

fn from(v: ReadonlyTag) -> Self

Converts to this type from the input type.

impl From<RequiresTag> for Tag

fn from(v: RequiresTag) -> Self

Converts to this type from the input type.

impl From<ReturnTag> for Tag

fn from(v: ReturnTag) -> Self

Converts to this type from the input type.

impl From<SeeTag> for Tag

fn from(v: SeeTag) -> Self

Converts to this type from the input type.

impl From<SinceTag> for Tag

fn from(v: SinceTag) -> Self

Converts to this type from the input type.

impl From<StaticTag> for Tag

fn from(v: StaticTag) -> Self

Converts to this type from the input type.

impl From<SummaryTag> for Tag

fn from(v: SummaryTag) -> Self

Converts to this type from the input type.

impl From<TemplateTag> for Tag

fn from(v: TemplateTag) -> Self

Converts to this type from the input type.

impl From<ThisTag> for Tag

fn from(v: ThisTag) -> Self

Converts to this type from the input type.

impl From<ThrowTag> for Tag

fn from(v: ThrowTag) -> Self

Converts to this type from the input type.

impl From<TodoTag> for Tag

fn from(v: TodoTag) -> Self

Converts to this type from the input type.

impl From<TutorialTag> for Tag

fn from(v: TutorialTag) -> Self

Converts to this type from the input type.

impl From<TypeDefTag> for Tag

fn from(v: TypeDefTag) -> Self

Converts to this type from the input type.

impl From<TypeTag> for Tag

fn from(v: TypeTag) -> Self

Converts to this type from the input type.

impl From<TypedefTag> for Tag

fn from(v: TypedefTag) -> Self

Converts to this type from the input type.

impl From<UnknownTag> for Tag

fn from(v: UnknownTag) -> Self

Converts to this type from the input type.

impl From<VariationTag> for Tag

fn from(v: VariationTag) -> Self

Converts to this type from the input type.

impl From<VersionTag> for Tag

fn from(v: VersionTag) -> Self

Converts to this type from the input type.

impl From<YieldTag> for Tag

fn from(v: YieldTag) -> Self

Converts to this type from the input type.

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 ==.

1.0.0 · source§

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. Read more

impl Spanned for Tag

fn span(&self) -> Span

Get span of self.

fn span_lo(&self) -> BytePos

fn span_hi(&self) -> BytePos

impl StructuralPartialEq for Tag

Auto Trait Implementations§

impl RefUnwindSafe for Tag

impl Send for Tag

impl Sync for Tag

impl Unpin for Tag

impl UnwindSafe for Tag

Blanket Implementations§

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,