Enum Token

pub enum Token<'input> {
    Error,
    WhiteSpace,
    DocComment(&'input str),
    Comment,
    Identifier(&'input str),
    LiteralFiniteSize(&'input str),
    LiteralName(&'input str),
    Omega,
    Theta,
    Semicolon,
    Comma,
    Colon,
    OpenCurly,
    CloseCurly,
    OpenParen,
    CloseParen,
    OpenBracket,
    CloseBracket,
    Add,
    ThinArrow,
    ThinBackArrow,
    FatArrow,
    FatBackArrow,
    FatTwowayArrow,
    Bang,
    Ces,
    Vis,
    Sat,
    Caps,
    Unbounded,
    Weights,
    Inhibit,
    Hold,
}

Variants

Error

WhiteSpace

DocComment(&'input str)

Comment

Identifier(&'input str)

LiteralFiniteSize(&'input str)

LiteralName(&'input str)

Omega

Theta

Semicolon

Comma

Colon

OpenCurly

CloseCurly

OpenParen

CloseParen

OpenBracket

CloseBracket

Add

ThinArrow

ThinBackArrow

FatArrow

FatBackArrow

FatTwowayArrow

Bang

Ces

Vis

Sat

Caps

Unbounded

Weights

Inhibit

Hold

Trait Implementations

impl<'input> Clone for Token<'input>

fn clone(&self) -> Token<'input>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'input> Debug for Token<'input>

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

Formats the value using the given formatter.

impl<'input> Display for Token<'input>

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

Formats the value using the given formatter.

impl<'input> From<Token<'input>> for String

fn from(token: Token<'input>) -> Self

Converts to this type from the input type.

impl<'s> Logos<'s> for Token<'s>

const SIZE: usize = 33usize

SIZE is simply a number of possible variants of the Logos enum. The derive macro will make sure that all variants don’t hold values larger or equal to SIZE.

const ERROR: Self = Token::Error

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

type Extras = ()

Associated type Extras for the particular lexer. Those can handle things that aren’t necessarily tokens, such as comments or Automatic Semicolon Insertion in JavaScript.

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>

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

impl<'input> PartialEq for Token<'input>

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

impl<'input> StructuralPartialEq for Token<'input>