Enum public_api::tokens::Token

pub enum Token {
    Symbol(String),
    Qualifier(String),
    Kind(String),
    Whitespace,
    Identifier(String),
    Annotation(String),
    Self_(String),
    Function(String),
    Lifetime(String),
    Keyword(String),
    Generic(String),
    Primitive(String),
    Type(String),
}

A token in a rendered PublicItem, used to apply syntax colouring in downstream applications.

Variants

Symbol(String)

A symbol, like = or ::<

Qualifier(String)

A qualifier, like pub or const

Kind(String)

The kind of an item, like function or trait

Whitespace

Whitespace, a single space

Identifier(String)

An identifier, like variable names or parts of the path of an item

Annotation(String)

An annotation, used e.g. for Rust attributes.

Self_(String)

The identifier self, the text can be self or Self

Function(String)

The identifier for a function, like fn_arg in comprehensive_api::functions::fn_arg

Lifetime(String)

A lifetime including the apostrophe ', like 'a

Keyword(String)

A keyword, like impl, where, or dyn

Generic(String)

A generic parameter, like T

Primitive(String)

A primitive type, like usize

Type(String)

A non-primitive type, like the name of a struct or a trait

Implementations

impl Token

pub fn len(&self) -> usize

Give the length of the inner text of this token

pub fn text(&self) -> &str

Get the inner text of this token

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Token

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

Formats the value using the given formatter.

impl Hash for Token

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 Token

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Token> for Token

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

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

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 PartialOrd<Token> for Token

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Token

impl StructuralEq for Token

impl StructuralPartialEq for Token