Enum TokenKind

pub enum TokenKind {
    Identifier(String),
    Integer((BigUint, LiteralKind)),
    HexInteger((BigUint, LiteralKind)),
    BinInteger((BigUint, LiteralKind)),
    True,
    False,
    Low,
    High,
    HighImp,
    Reg,
    Let,
    Decl,
    Instance,
    Reset,
    Initial,
    If,
    Else,
    Match,
    Set,
    Pipeline,
    Stage,
    Entity,
    Trait,
    Impl,
    For,
    Function,
    Enum,
    Struct,
    Port,
    Mod,
    Use,
    As,
    Assert,
    Mut,
    Inv,
    Where,
    Gen,
    Extern,
    Plus,
    Minus,
    Asterisk,
    Slash,
    Percentage,
    Equals,
    NotEquals,
    Lt,
    Gt,
    Le,
    Ge,
    ArithmeticRightShift,
    RightShift,
    LeftShift,
    LogicalOr,
    LogicalAnd,
    LogicalXor,
    Ampersand,
    BitwiseOr,
    Not,
    BitwiseXor,
    Tilde,
    InfixOperatorSeparator,
    SingleQuote,
    Assignment,
    OpenParen,
    CloseParen,
    OpenBrace,
    CloseBrace,
    OpenBracket,
    CloseBracket,
    FatArrow,
    SlimArrow,
    Comma,
    Dot,
    DotDot,
    Semi,
    GreekQuestionMark,
    Colon,
    PathSeparator,
    Hash,
    Dollar,
    OutsideDocumentation(String),
    InsideDocumentation(String),
    Whitespace,
    Comment,
    BlockCommentStart,
    BlockCommentEnd,
    Eof,
}

Variants

Identifier(String)

Integer((BigUint, LiteralKind))

HexInteger((BigUint, LiteralKind))

BinInteger((BigUint, LiteralKind))

True

False

Low

High

HighImp

Reg

Let

Decl

Instance

Reset

Initial

If

Else

Match

Set

Pipeline

Stage

Entity

Trait

Impl

For

Function

Enum

Struct

Port

Mod

Use

As

Assert

Mut

Inv

Where

Gen

Extern

Plus

Minus

Asterisk

Slash

Percentage

Equals

NotEquals

Lt

Gt

Le

Ge

ArithmeticRightShift

RightShift

LeftShift

LogicalOr

LogicalAnd

LogicalXor

Ampersand

BitwiseOr

Not

BitwiseXor

Tilde

InfixOperatorSeparator

SingleQuote

Assignment

OpenParen

CloseParen

OpenBrace

CloseBrace

OpenBracket

CloseBracket

FatArrow

SlimArrow

Comma

Dot

DotDot

Semi

GreekQuestionMark

Colon

PathSeparator

Hash

Dollar

OutsideDocumentation(String)

InsideDocumentation(String)

Whitespace

Ignoring whitespace

Comment

BlockCommentStart

BlockCommentEnd

Eof

Implementations

impl TokenKind

pub fn as_str(&self) -> &'static str

pub fn is_identifier(&self) -> bool

pub fn is_integer(&self) -> bool

pub fn as_biguint(&self) -> Option<BigUint>

Trait Implementations

impl Clone for TokenKind

fn clone(&self) -> TokenKind

Returns a duplicate of the value.

const 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

type Error = ()

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 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 StructuralPartialEq for TokenKind