Enum TagKind

#[non_exhaustive]
pub enum TagKind {
    Abstract,
    Access,
    Author,
    Category,
    Copyright,
    Deprecated,
    Example,
    Final,
    FileSource,
    Global,
    Ignore,
    Internal,
    License,
    Link,
    Method,
    Mixin,
    Name,
    Package,
    Param,
    Property,
    PropertyRead,
    PropertyWrite,
    SealProperties,
    NoSealProperties,
    SealMethods,
    NoSealMethods,
    ReadOnly,
    NoNamedArguments,
    Template,
    PsalmTemplate,
    Api,
    PsalmApi,
    PsalmInheritors,
    Return,
    See,
    Since,
    Static,
    StaticVar,
    SubPackage,
    Todo,
    Tutorial,
    Uses,
    Var,
    Throws,
    Version,
    ParamLaterInvokedCallable,
    ParamImmediatelyInvokedCallable,
    ParamClosureThis,
    TemplateCovariant,
    TemplateContravariant,
    Extends,
    Implements,
    Use,
    NotDeprecated,
    PhpstanImpure,
    PhpstanPure,
    Pure,
    Immutable,
    InheritDoc,
    ParamOut,
    PsalmConsistentConstructor,
    PsalmConsistentTemplates,
    PsalmParamOut,
    PsalmVar,
    PsalmParam,
    PsalmReturn,
    PsalmProperty,
    PsalmPropertyRead,
    PsalmPropertyWrite,
    PsalmMethod,
    PsalmIgnoreVar,
    PsalmSuppress,
    PsalmAssert,
    PsalmAssertIfTrue,
    PsalmAssertIfFalse,
    PsalmIfThisIs,
    PsalmThisOut,
    PsalmIgnoreNullableReturn,
    PsalmIgnoreFalsableReturn,
    PsalmSealProperties,
    PsalmNoSealProperties,
    PsalmSealMethods,
    PsalmNoSealMethods,
    PsalmInternal,
    PsalmReadOnly,
    PsalmMutationFree,
    PsalmExternalMutationFree,
    PsalmImmutable,
    PsalmPure,
    PsalmAllowPrivateMutation,
    PsalmReadOnlyAllowPrivateMutation,
    PsalmTrace,
    PsalmCheckType,
    PsalmCheckTypeExact,
    PsalmTaintSource,
    PsalmTaintSink,
    PsalmTaintEscape,
    PsalmTaintUnescape,
    PsalmTaintSpecialize,
    PsalmFlow,
    PsalmType,
    PsalmImportType,
    PsalmRequireExtends,
    PsalmRequireImplements,
    PsalmIgnoreVariableProperty,
    PsalmIgnoreVariableMethod,
    PsalmYield,
    PhpstanAssert,
    PhpstanAssertIfTrue,
    PhpstanAssertIfFalse,
    PhpstanSelfOut,
    PhpstanThisOut,
    PhpstanRequireExtends,
    PhpstanRequireImplements,
    PhpstanTemplate,
    PhpstanTemplateCovariant,
    PhpstanTemplateContravariant,
    PhpstanParam,
    PhpstanReturn,
    PhpstanVar,
    PhpstanReadOnly,
    PhpstanImmutable,
    Other,
}

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.

Abstract

Access

Author

Category

Copyright

Deprecated

Example

Final

FileSource

Global

Ignore

Internal

License

Link

Method

Mixin

Name

Package

Param

Property

PropertyRead

PropertyWrite

SealProperties

NoSealProperties

SealMethods

NoSealMethods

ReadOnly

NoNamedArguments

Template

PsalmTemplate

Api

PsalmApi

PsalmInheritors

Return

See

Since

Static

StaticVar

SubPackage

Todo

Tutorial

Uses

Var

Throws

Version

ParamLaterInvokedCallable

ParamImmediatelyInvokedCallable

ParamClosureThis

TemplateCovariant

TemplateContravariant

Extends

Implements

Use

NotDeprecated

PhpstanImpure

PhpstanPure

Pure

Immutable

InheritDoc

ParamOut

PsalmConsistentConstructor

PsalmConsistentTemplates

PsalmParamOut

PsalmVar

PsalmParam

PsalmReturn

PsalmProperty

PsalmPropertyRead

PsalmPropertyWrite

PsalmMethod

PsalmIgnoreVar

PsalmSuppress

PsalmAssert

PsalmAssertIfTrue

PsalmAssertIfFalse

PsalmIfThisIs

PsalmThisOut

PsalmIgnoreNullableReturn

PsalmIgnoreFalsableReturn

PsalmSealProperties

PsalmNoSealProperties

PsalmSealMethods

PsalmNoSealMethods

PsalmInternal

PsalmReadOnly

PsalmMutationFree

PsalmExternalMutationFree

PsalmImmutable

PsalmPure

PsalmAllowPrivateMutation

PsalmReadOnlyAllowPrivateMutation

PsalmTrace

PsalmCheckType

PsalmCheckTypeExact

PsalmTaintSource

PsalmTaintSink

PsalmTaintEscape

PsalmTaintUnescape

PsalmTaintSpecialize

PsalmFlow

PsalmType

PsalmImportType

PsalmRequireExtends

PsalmRequireImplements

PsalmIgnoreVariableProperty

PsalmIgnoreVariableMethod

PsalmYield

PhpstanAssert

PhpstanAssertIfTrue

PhpstanAssertIfFalse

PhpstanSelfOut

PhpstanThisOut

PhpstanRequireExtends

PhpstanRequireImplements

PhpstanTemplate

PhpstanTemplateCovariant

PhpstanTemplateContravariant

PhpstanParam

PhpstanReturn

PhpstanVar

PhpstanReadOnly

PhpstanImmutable

Other

Implementations

impl TagKind

pub fn get_vendor(&self) -> Option<TagVendor>

Returns the vendor of the tag, if it has one.

If the tag does not have a vendor, None is returned.

pub fn get_non_vendored_variant(&self) -> Option<TagKind>

Returns the non-vendored variant of the tag, if it exists.

Note that not all vendored tags have a non-vendored variant.

If the tag is not vendored, or if it does not have a non-vendored variant, None is returned.

pub fn is_repeatable(&self) -> bool

Trait Implementations

impl Clone for TagKind

fn clone(&self) -> TagKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TagKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TagKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<T> for TagKind

where T: AsRef<str>,

fn from(value: T) -> Self

Converts to this type from the input type.

impl Hash for TagKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TagKind

fn cmp(&self, other: &TagKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TagKind

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for TagKind

fn partial_cmp(&self, other: &TagKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TagKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TagKind

impl Eq for TagKind

impl StructuralPartialEq for TagKind