Enum TokenKind

pub enum TokenKind {
    Error,
    Newline,
    Name,
    Int,
    Hex,
    Octal,
    Binary,
    Text,
    True,
    False,
    Assert,
    Break,
    Continue,
    Contract,
    Fn,
    Const,
    Else,
    Idx,
    If,
    Match,
    Impl,
    Pragma,
    For,
    Pub,
    Return,
    Revert,
    SelfType,
    SelfValue,
    Struct,
    Enum,
    Trait,
    Type,
    Unsafe,
    While,
    And,
    As,
    In,
    Not,
    Or,
    Let,
    Mut,
    Use,
    ParenOpen,
    ParenClose,
    BracketOpen,
    BracketClose,
    BraceOpen,
    BraceClose,
    Colon,
    ColonColon,
    Comma,
    Hash,
    Semi,
    Plus,
    Minus,
    Star,
    Slash,
    Pipe,
    Amper,
    Lt,
    LtLt,
    Gt,
    GtGt,
    Eq,
    Dot,
    DotDot,
    Percent,
    EqEq,
    NotEq,
    LtEq,
    GtEq,
    Tilde,
    Hat,
    StarStar,
    StarStarEq,
    PlusEq,
    MinusEq,
    StarEq,
    SlashEq,
    PercentEq,
    AmperEq,
    PipeEq,
    HatEq,
    LtLtEq,
    GtGtEq,
    Arrow,
    FatArrow,
}

Variants

Error

Newline

Name

Int

Hex

Octal

Binary

Text

True

False

Assert

Break

Continue

Contract

Fn

Const

Else

Idx

If

Match

Impl

Pragma

For

Pub

Return

Revert

SelfType

SelfValue

Struct

Enum

Trait

Type

Unsafe

While

And

As

In

Not

Or

Let

Mut

Use

ParenOpen

ParenClose

BracketOpen

BracketClose

BraceOpen

BraceClose

Colon

ColonColon

Comma

Hash

Semi

Plus

Minus

Star

Slash

Pipe

Amper

Lt

LtLt

Gt

GtGt

Eq

Dot

DotDot

Percent

EqEq

NotEq

LtEq

GtEq

Tilde

Hat

StarStar

StarStarEq

PlusEq

MinusEq

StarEq

SlashEq

PercentEq

AmperEq

PipeEq

HatEq

LtLtEq

GtGtEq

Arrow

FatArrow

Implementations

impl TokenKind

pub fn describe(&self) -> &str

Return a user-friendly description of the token kind. E.g. TokenKind::Newline => “a newline” TokenKind::Colon => “:”

Trait Implementations

impl Clone for TokenKind

fn clone(&self) -> TokenKind

Returns a copy 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<'s> Logos<'s> for TokenKind

const ERROR: Self = TokenKind::Error

Helper const of the variant marked as #[error].

type Extras = ()

Associated type Extras for the particular lexer. This can be set using #[logos(extras = MyExtras)] and accessed inside callbacks.

type Source = str

Source type this token can be lexed from. This will default to str, unless one of the defined patterns explicitly uses non-unicode byte values or byte slices, in which case that implementation will use [u8].

fn lex(lex: &mut Lexer<'s, Self>)

The heart of Logos. Called by the Lexer. The implementation for this function is generated by the logos-derive crate.

fn lexer(source: &'source Self::Source) -> Lexer<'source, Self>

where Self::Extras: Default,

Create a new instance of a Lexer that will produce tokens implementing this Logos.

fn lexer_with_extras( source: &'source Self::Source, extras: Self::Extras, ) -> Lexer<'source, Self>

Create a new instance of a Lexer with the provided Extras that will produce tokens implementing this Logos.

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