Enum Token

pub enum Token {
    Module,
    EndModule,
    Parameter,
    Inout,
    Input,
    Output,
    Reg,
    Wire,
    Assign,
    Comb,
    If,
    Else,
    Begin,
    End,
    Posedge,
    Negedge,
    Timescale,
    Time(f64),
    Pound,
    OpenParen,
    CloseParen,
    OpenBracket,
    CloseBracket,
    OpenBrace,
    CloseBrace,
    BEQ,
    BLT,
    BGT,
    BLTE,
    BGTE,
    Equals,
    Subtract,
    Add,
    Multiply,
    Divide,
    QMark,
    EMark,
    Colon,
    Semicolon,
    Comma,
    BTick,
    Underscore,
    At,
    Newline,
    WhiteSpace,
    BinaryValue,
    HiZValue,
    Comment,
    Word,
    Integer(u64),
}

Lexer token output

Variants

Module

Module start

EndModule

Module end

Parameter

Parameter start

Inout

Inout start

Input

Input start

Output

Output start

Reg

Register start

Wire

Wire start

Assign

Assign start

Comb

Combinational logic start

If

If statement start

Else

Else statement start

Begin

Begin statement

End

End statement

Posedge

Rising edge trigger

Negedge

Negative edge trigger

Timescale

Timescale start

Time(f64)

Simulation time

Accepts times in ns or ps

Pound

Pound symbol

OpenParen

Open parenthesis

CloseParen

Close parenthesis

OpenBracket

Open bracket

CloseBracket

Close bracket

OpenBrace

Open brace

CloseBrace

Close brace

BEQ

Equivalent comparison

BLT

Less than comparison

BGT

Greater than comparison

BLTE

Less than or equal to comparison

BGTE

Greater than or equal to comparison

Equals

Assignment start

Subtract

Subtraction

Add

Addition

Multiply

Multiply

Divide

Divide

QMark

Question mark

EMark

Exclamation point

Colon

Colon

Semicolon

Semicolon

Comma

Comma

BTick

Back tick

Underscore

Underscore

At

At symbol

Newline

Newline

WhiteSpace

Whitespace

BinaryValue

Binary value

Takes form X'bY where X is the bit width and Y is the desired value

HiZValue

Hi-Z value

Takes form X'bz where X is the bit width

Comment

Comment start

Word

Generic text

Integer(u64)

Integer value

Trait Implementations

impl Debug for Token

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

Formats the value using the given formatter.

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

type Error = LexingError

Error type returned by the lexer. This can be set using #[logos(error = MyError)]. Defaults to () if not set.

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 Token

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