Enum jsdoc::ast::Tag[−][src]

#[non_exhaustive]
pub enum Tag {

Show 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(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)
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)
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[src]

fn clone(&self) -> Tag[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for Tag[src]

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Tag[src]

fn deserialize<D>(Deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, [src]

Deserialize this value from the given Serde deserializer. Read more

impl From<AbstractTag> for Tag[src]

fn from(v: AbstractTag) -> Self[src]

Performs the conversion.

impl From<AccessTag> for Tag[src]

fn from(v: AccessTag) -> Self[src]

Performs the conversion.

impl From<AliasTag> for Tag[src]

fn from(v: AliasTag) -> Self[src]

Performs the conversion.

impl From<AsyncTag> for Tag[src]

fn from(v: AsyncTag) -> Self[src]

Performs the conversion.

impl From<AugmentsTag> for Tag[src]

fn from(v: AugmentsTag) -> Self[src]

Performs the conversion.

impl From<AuthorTag> for Tag[src]

fn from(v: AuthorTag) -> Self[src]

Performs the conversion.

impl From<BorrowsTag> for Tag[src]

fn from(v: BorrowsTag) -> Self[src]

Performs the conversion.

impl From<CallbackTag> for Tag[src]

fn from(v: CallbackTag) -> Self[src]

Performs the conversion.

impl From<ClassTag> for Tag[src]

fn from(v: ClassTag) -> Self[src]

Performs the conversion.

impl From<ConstTag> for Tag[src]

fn from(v: ConstTag) -> Self[src]

Performs the conversion.

impl From<ConstructsTag> for Tag[src]

fn from(v: ConstructsTag) -> Self[src]

Performs the conversion.

impl From<CopyrightTag> for Tag[src]

fn from(v: CopyrightTag) -> Self[src]

Performs the conversion.

impl From<DefaultTag> for Tag[src]

fn from(v: DefaultTag) -> Self[src]

Performs the conversion.

impl From<DeprecatedTag> for Tag[src]

fn from(v: DeprecatedTag) -> Self[src]

Performs the conversion.

impl From<DescriptionTag> for Tag[src]

fn from(v: DescriptionTag) -> Self[src]

Performs the conversion.

impl From<EnumTag> for Tag[src]

fn from(v: EnumTag) -> Self[src]

Performs the conversion.

impl From<ExampleTag> for Tag[src]

fn from(v: ExampleTag) -> Self[src]

Performs the conversion.

impl From<ExportsTag> for Tag[src]

fn from(v: ExportsTag) -> Self[src]

Performs the conversion.

impl From<ExternalTag> for Tag[src]

fn from(v: ExternalTag) -> Self[src]

Performs the conversion.

impl From<FilelTag> for Tag[src]

fn from(v: FilelTag) -> Self[src]

Performs the conversion.

impl From<FunctionTag> for Tag[src]

fn from(v: FunctionTag) -> Self[src]

Performs the conversion.

impl From<GeneratorTag> for Tag[src]

fn from(v: GeneratorTag) -> Self[src]

Performs the conversion.

impl From<HideConstructorTag> for Tag[src]

fn from(v: HideConstructorTag) -> Self[src]

Performs the conversion.

impl From<IgnoreTag> for Tag[src]

fn from(v: IgnoreTag) -> Self[src]

Performs the conversion.

impl From<ImplementsTag> for Tag[src]

fn from(v: ImplementsTag) -> Self[src]

Performs the conversion.

impl From<InheritDocTag> for Tag[src]

fn from(v: InheritDocTag) -> Self[src]

Performs the conversion.

impl From<InnerTag> for Tag[src]

fn from(v: InnerTag) -> Self[src]

Performs the conversion.

impl From<InstanceTag> for Tag[src]

fn from(v: InstanceTag) -> Self[src]

Performs the conversion.

impl From<InterfaceTag> for Tag[src]

fn from(v: InterfaceTag) -> Self[src]

Performs the conversion.

impl From<JSDocClassDescTag> for Tag[src]

fn from(v: JSDocClassDescTag) -> Self[src]

Performs the conversion.

impl From<KindTag> for Tag[src]

fn from(v: KindTag) -> Self[src]

Performs the conversion.

impl From<LendsTag> for Tag[src]

fn from(v: LendsTag) -> Self[src]

Performs the conversion.

impl From<LicenseTag> for Tag[src]

fn from(v: LicenseTag) -> Self[src]

Performs the conversion.

impl From<ListensTag> for Tag[src]

fn from(v: ListensTag) -> Self[src]

Performs the conversion.

impl From<MemberOfTag> for Tag[src]

fn from(v: MemberOfTag) -> Self[src]

Performs the conversion.

impl From<MemberTag> for Tag[src]

fn from(v: MemberTag) -> Self[src]

Performs the conversion.

impl From<MixesTag> for Tag[src]

fn from(v: MixesTag) -> Self[src]

Performs the conversion.

impl From<MixinTag> for Tag[src]

fn from(v: MixinTag) -> Self[src]

Performs the conversion.

impl From<ModuleTag> for Tag[src]

fn from(v: ModuleTag) -> Self[src]

Performs the conversion.

impl From<NameTag> for Tag[src]

fn from(v: NameTag) -> Self[src]

Performs the conversion.

impl From<NamespaceTag> for Tag[src]

fn from(v: NamespaceTag) -> Self[src]

Performs the conversion.

impl From<OverrideTag> for Tag[src]

fn from(v: OverrideTag) -> Self[src]

Performs the conversion.

impl From<PackageTag> for Tag[src]

fn from(v: PackageTag) -> Self[src]

Performs the conversion.

impl From<ParameterTag> for Tag[src]

fn from(v: ParameterTag) -> Self[src]

Performs the conversion.

impl From<PrivateTag> for Tag[src]

fn from(v: PrivateTag) -> Self[src]

Performs the conversion.

impl From<PropertyTag> for Tag[src]

fn from(v: PropertyTag) -> Self[src]

Performs the conversion.

impl From<ProtectedTag> for Tag[src]

fn from(v: ProtectedTag) -> Self[src]

Performs the conversion.

impl From<PublicTag> for Tag[src]

fn from(v: PublicTag) -> Self[src]

Performs the conversion.

impl From<ReadonlyTag> for Tag[src]

fn from(v: ReadonlyTag) -> Self[src]

Performs the conversion.

impl From<RequiresTag> for Tag[src]

fn from(v: RequiresTag) -> Self[src]

Performs the conversion.

impl From<ReturnTag> for Tag[src]

fn from(v: ReturnTag) -> Self[src]

Performs the conversion.

impl From<SeeTag> for Tag[src]

fn from(v: SeeTag) -> Self[src]

Performs the conversion.

impl From<SinceTag> for Tag[src]

fn from(v: SinceTag) -> Self[src]

Performs the conversion.

impl From<StaticTag> for Tag[src]

fn from(v: StaticTag) -> Self[src]

Performs the conversion.

impl From<SummaryTag> for Tag[src]

fn from(v: SummaryTag) -> Self[src]

Performs the conversion.

impl From<TemplateTag> for Tag[src]

fn from(v: TemplateTag) -> Self[src]

Performs the conversion.

impl From<ThisTag> for Tag[src]

fn from(v: ThisTag) -> Self[src]

Performs the conversion.

impl From<ThrowTag> for Tag[src]

fn from(v: ThrowTag) -> Self[src]

Performs the conversion.

impl From<TodoTag> for Tag[src]

fn from(v: TodoTag) -> Self[src]

Performs the conversion.

impl From<TutorialTag> for Tag[src]

fn from(v: TutorialTag) -> Self[src]

Performs the conversion.

impl From<TypeDefTag> for Tag[src]

fn from(v: TypeDefTag) -> Self[src]

Performs the conversion.

impl From<TypeTag> for Tag[src]

fn from(v: TypeTag) -> Self[src]

Performs the conversion.

impl From<TypedefTag> for Tag[src]

fn from(v: TypedefTag) -> Self[src]

Performs the conversion.

impl From<UnknownTag> for Tag[src]

fn from(v: UnknownTag) -> Self[src]

Performs the conversion.

impl From<VariationTag> for Tag[src]

fn from(v: VariationTag) -> Self[src]

Performs the conversion.

impl From<VersionTag> for Tag[src]

fn from(v: VersionTag) -> Self[src]

Performs the conversion.

impl From<YieldTag> for Tag[src]

fn from(v: YieldTag) -> Self[src]

Performs the conversion.

impl PartialEq<Tag> for Tag[src]

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

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

fn ne(&self, other: &Tag) -> bool[src]

This method tests for !=.

impl Serialize for Tag[src]

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, [src]

Serialize this value into the given Serde serializer. Read more

impl Spanned for Tag[src]

fn span(&self) -> Span[src]

Get span of self.

impl StructuralPartialEq for Tag[src]

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 T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, [src]

impl<T> Send for T where
    T: ?Sized, [src]

impl<T> Sync for T where
    T: ?Sized, [src]