Enum TokenKind

pub enum TokenKind {
    Eq,
    Lt,
    Le,
    EqEq,
    Ne,
    Ge,
    Gt,
    AndAnd,
    OrOr,
    Not,
    Tilde,
    Walrus,
    PlusPlus,
    MinusMinus,
    StarStar,
    BinOp(BinOpToken),
    BinOpEq(BinOpToken),
    At,
    Dot,
    Comma,
    Semi,
    Colon,
    Arrow,
    FatArrow,
    Question,
    OpenDelim(Delimiter),
    CloseDelim(Delimiter),
    Literal(TokenLitKind, Symbol),
    Ident(Symbol),
    Comment(bool, CommentKind, Symbol),
    Eof,
}

A kind of token.

Variants

Eq

=

Lt

<

Le

<=

EqEq

==

Ne

!=

Ge

>=

Gt

>

AndAnd

&&

OrOr

||

Not

!

Tilde

~

Walrus

:=

PlusPlus

++

MinusMinus

--

StarStar

**

BinOp(BinOpToken)

A binary operator token.

BinOpEq(BinOpToken)

A binary operator token, followed by an equals sign (=).

At

@

Dot

.

Comma

,

Semi

;

Colon

:

Arrow

->

FatArrow

=>

Question

?

OpenDelim(Delimiter)

An opening delimiter (e.g., {).

CloseDelim(Delimiter)

A closing delimiter (e.g., }).

Literal(TokenLitKind, Symbol)

A literal token.

Note that this does not include boolean literals.

Symbol is the literal’s parsed data. In string literals, this is the unescaped value, and excludes its quotes (", ') and prefix (hex, unicode).

Ident(Symbol)

Identifier token.

Comment(bool, CommentKind, Symbol)

A comment or doc-comment token.

Symbol is the comment’s data excluding its “quotes” (//, /**) similarly to symbols in string literal tokens.

Eof

End of file marker.

Implementations

impl TokenKind

pub fn lit(kind: TokenLitKind, symbol: Symbol) -> Self

Creates a new literal token kind.

pub fn as_str(&self) -> &str

Returns the string representation of the token kind.

pub fn description(&self) -> Cow<'_, str>

Returns the description of the token kind.

pub const fn is_op(&self) -> bool

Returns true if the token kind is an operator.

pub fn as_unop(&self, is_postfix: bool) -> Option<UnOpKind>

Returns the token kind as a unary operator, if any.

pub fn as_binop(&self) -> Option<BinOpKind>

Returns the token kind as a binary operator, if any.

pub fn as_binop_eq(&self) -> Option<BinOpKind>

Returns the token kind as a binary operator, if any.

pub const fn is_comment(&self) -> bool

Returns true if the token kind is a normal comment (not a doc-comment).

pub const fn is_comment_or_doc(&self) -> bool

Returns true if the token kind is a comment or doc-comment.

Trait Implementations

impl Clone for TokenKind

fn clone(&self) -> TokenKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenKind

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

Formats the value using the given formatter.

impl Display for TokenKind

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

Formats the value using the given formatter.

impl PartialEq for TokenKind

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

impl Eq for TokenKind

impl StructuralPartialEq for TokenKind