Enum Token

pub enum Token {
    EOF,
    Indent,
    Dedent,
    Info(String),
    Annotations(String),
    ID(Int),
    Space,
    Tab,
    Newline,
    RadixInt(String),
    IntegerDec(Int),
    Identifier(String),
    String(String),
    Slash,
    LeftSquare,
    RightSquare,
    LeftAngle,
    RightAngle,
    LeftBracket,
    RightBracket,
    LeftParenthesis,
    RightParenthesis,
    AtSymbol,
    Backtick,
    AnnoStart,
    DoubleLeft,
    DoubleRight,
    Clock,
    Reset,
    AsyncReset,
    UInt,
    SInt,
    ProbeType,
    Probe,
    Analog,
    Fixed,
    Flip,
    E2Op(String),
    E1Op(String),
    E1I1Op(String),
    E1I2Op(String),
    Mux,
    ValidIf,
    SMem,
    CMem,
    Write,
    Read,
    Infer,
    Mport,
    DataType,
    Depth,
    ReadLatency,
    WriteLatency,
    ReadUnderWrite,
    Reader,
    Writer,
    Readwriter,
    Wire,
    Reg,
    RegReset,
    Inst,
    Of,
    Node,
    Invalidate,
    Attach,
    When,
    Else,
    Stop,
    Printf,
    Assert,
    Skip,
    Input,
    Output,
    Module,
    ExtModule,
    DefName,
    Parameter,
    IntModule,
    Intrinsic,
    FIRRTL,
    Version,
    Circuit,
    Connect,
    Public,
    Define,
    Const,
    Symbol(String),
    Period,
    Error,
}

Variants

EOF

Indent

Dedent

Info(String)

Annotations(String)

ID(Int)

Space

Tab

Newline

RadixInt(String)

IntegerDec(Int)

Identifier(String)

String(String)

Slash

LeftSquare

RightSquare

LeftAngle

RightAngle

LeftBracket

RightBracket

LeftParenthesis

RightParenthesis

AtSymbol

Backtick

AnnoStart

DoubleLeft

DoubleRight

Clock

Reset

AsyncReset

UInt

SInt

ProbeType

Probe

Analog

Fixed

Flip

E2Op(String)

E1Op(String)

E1I1Op(String)

E1I2Op(String)

Mux

ValidIf

SMem

CMem

Write

Read

Infer

Mport

DataType

Depth

ReadLatency

WriteLatency

ReadUnderWrite

Reader

Writer

Readwriter

Wire

Reg

RegReset

Inst

Of

Node

Invalidate

Attach

When

Else

Stop

Printf

Assert

Skip

Input

Output

Module

ExtModule

DefName

Parameter

IntModule

Intrinsic

FIRRTL

Version

Circuit

Connect

Public

Define

Const

Symbol(String)

Period

Error

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a duplicate 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<'s> Logos<'s> for Token

const ERROR: Self = Token::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 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