Enum DocblockTagKind 

pub enum DocblockTagKind {
    Param,
    Return,
    Throws,
    Var,
    Property,
    Method,
    Template,
    Deprecated,
    Since,
    See,
    Other,
}

Common PHPDoc tag kind metadata.

Variants

Param

Return

Throws

Var

Property

Method

Template

Deprecated

Since

See

Other

Implementations

impl DocblockTagKind

pub const fn as_str(self) -> &'static str

Trait Implementations

impl Clone for DocblockTagKind

fn clone(&self) -> DocblockTagKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocblockTagKind

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

Formats the value using the given formatter.

impl Display for DocblockTagKind

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

Formats the value using the given formatter.

impl FromStr for DocblockTagKind

type Err = PhpDocblockError

The associated error which can be returned from parsing.

fn from_str( input: &str, ) -> Result<DocblockTagKind, <DocblockTagKind as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for DocblockTagKind

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

where __H: Hasher,

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 DocblockTagKind

fn cmp(&self, other: &DocblockTagKind) -> 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 DocblockTagKind

fn eq(&self, other: &DocblockTagKind) -> 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 DocblockTagKind

fn partial_cmp(&self, other: &DocblockTagKind) -> 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 Copy for DocblockTagKind

impl Eq for DocblockTagKind

impl StructuralPartialEq for DocblockTagKind