Enum Token

#[repr(u16)]
pub enum Token {
    Space = 0,
    Extern = 1,
    Unsafe = 2,
    And = 3,
    Arrow = 4,
    Assert = 5,
    Bar = 6,
    Bool = 7,
    CDots = 8,
    CloseBrace = 9,
    CloseBracket = 10,
    ClosePar = 11,
    CloseStaticPar = 12,
    Colon = 13,
    Comma = 14,
    Const = 15,
    Current = 16,
    Diese = 17,
    Div = 18,
    DoubleColon = 19,
    Dot = 20,
    Equal = 21,
    Else = 22,
    Enum = 23,
    False = 24,
    Function = 25,
    Gt = 26,
    Gte = 27,
    Hat = 28,
    IConst = 29,
    IConstAndCDots = 30,
    Ident = 31,
    If = 32,
    Impl = 33,
    Int = 34,
    Let = 35,
    Lt = 36,
    Lte = 37,
    Merge = 38,
    Minus = 39,
    Mod = 40,
    Neq = 41,
    Node = 42,
    Nor = 43,
    Not = 44,
    OpenBrace = 45,
    OpenBracket = 46,
    OpenPar = 47,
    OpenStaticPar = 48,
    Operator = 49,
    Or = 50,
    Percent = 51,
    Plus = 52,
    Power = 53,
    Pre = 54,
    FBy = 55,
    RConst = 56,
    Real = 57,
    Returns = 58,
    Semicolon = 59,
    Slash = 60,
    Star = 61,
    Step = 62,
    Struct = 63,
    Tel = 64,
    Then = 65,
    True = 66,
    Type = 67,
    Var = 68,
    When = 69,
    With = 70,
    Xor = 71,
    Model = 72,
    Package = 73,
    Needs = 74,
    Provides = 75,
    Uses = 76,
    Is = 77,
    Body = 78,
    End = 79,
    Include = 80,
    Str = 81,
    InlineComment = 82,
    Comment = 83,
    Error = 84,
    Root = 85,
    IncludeStatement = 86,
    PackageDeclNode = 87,
    PackageDeclBody = 88,
    PackageAliasNode = 89,
    UsesNode = 90,
    ProvidesListNode = 91,
    ProvidesNode = 92,
    ModelDeclNode = 93,
    IdRefNode = 94,
    IdNode = 95,
    PragmaNode = 96,
    TypedIdsNode = 97,
    TypedValuedLv6IdNode = 98,
    NodeNode = 99,
    NodeProfileNode = 100,
    ParamsNode = 101,
    VarDeclNode = 102,
    ConstantDeclNode = 103,
    OneConstantDeclNode = 104,
    TypeDeclNode = 105,
    OneTypeDeclNode = 106,
    EnumDeclNode = 107,
    StructDeclNode = 108,
    TypeNode = 109,
    ExternalNodeDeclNode = 110,
    StaticParamsNode = 111,
    StaticParamNode = 112,
    EffectiveNodeNode = 113,
    StaticArgsNode = 114,
    StaticArgNode = 115,
    NamedStaticArgsNode = 116,
    NamedStaticArgNode = 117,
    BodyNode = 118,
    AssertEquationNode = 119,
    EqualsEquationNode = 120,
    LeftNode = 121,
    LeftItemListNode = 122,
    LeftItemNode = 123,
    LeftFieldAccessNode = 124,
    LeftTableAccessNode = 125,
    SelectNode = 126,
    StepNode = 127,
    ExpressionNode = 128,
    ExpressionListNode = 129,
    ParExpressionNode = 130,
    ArrayLiteralExpressionNode = 131,
    IdentExpressionNode = 132,
    FbyExpressionNode = 133,
    CallByPosExpressionNode = 134,
    ArrayAccessExpressionNode = 135,
    HatExpressionNode = 136,
    FieldAccessExpressionNode = 137,
    NegExpressionNode = 138,
    PreExpressionNode = 139,
    CurrentExpressionNode = 140,
    DieseExpressionNode = 141,
    NorExpressionNode = 142,
    IntExpressionNode = 143,
    RealExpressionNode = 144,
    WhenExpressionNode = 145,
    PowerExpressionNode = 146,
    MulExpressionNode = 147,
    DivExpressionNode = 148,
    ModExpressionNode = 149,
    AddExpressionNode = 150,
    SubExpressionNode = 151,
    NotExpressionNode = 152,
    LtExpressionNode = 153,
    LteExpressionNode = 154,
    EqExpressionNode = 155,
    GteExpressionNode = 156,
    GtExpressionNode = 157,
    NeqExpressionNode = 158,
    AndExpressionNode = 159,
    OrExpressionNode = 160,
    XorExpressionNode = 161,
    ImplExpressionNode = 162,
    ArrowExpressionNode = 163,
    ConcatExpressionNode = 164,
    IfExpressionNode = 165,
    WithExpressionNode = 166,
    ClockExpressionNode = 167,
    MergeExpressionNode = 168,
    MergeCaseNode = 169,
    PredefOp = 170,
    CallByNameExpressionNode = 171,
    CallByNameParamNode = 172,
    ConstantNode = 173,
}

A token

Variants

Space = 0

Whitespace character

Includes: spaces, tabs, newlines, carriage returns, form feeds

Extern = 1

Unsafe = 2

And = 3

Arrow = 4

Assert = 5

Bar = 6

Bool = 7

CDots = 8

CloseBrace = 9

CloseBracket = 10

ClosePar = 11

CloseStaticPar = 12

Colon = 13

Comma = 14

Const = 15

Current = 16

Diese = 17

Div = 18

DoubleColon = 19

Dot = 20

Equal = 21

Else = 22

Enum = 23

False = 24

Function = 25

Gt = 26

Gte = 27

Hat = 28

IConst = 29

IConstAndCDots = 30

A very special case to handle an IConst directly followed by a .. (CDots) operator.

This specialization is important to be able to parse RConst properly, or else 1..2 would be parsed as 1. . 2 which is a syntax error and not what’s supposed to be parsed in the first place.

This weird trick of treating two tokens as one could be avoided if logos supported regex lookaheads, so RConst could reject a list of digits followed by 2 dots.

Ident = 31

If = 32

Impl = 33

Int = 34

Let = 35

Lt = 36

Lte = 37

Merge = 38

Minus = 39

Mod = 40

Neq = 41

Node = 42

Nor = 43

Not = 44

OpenBrace = 45

OpenBracket = 46

OpenPar = 47

OpenStaticPar = 48

Operator = 49

Or = 50

Percent = 51

Plus = 52

Power = 53

Pre = 54

FBy = 55

RConst = 56

Recognizes a floating-point literal

The regex is intentionally a bit greedy, but this gives room for better errors if the value is unparseable.

Real = 57

Returns = 58

Semicolon = 59

Slash = 60

Star = 61

Step = 62

Struct = 63

Tel = 64

Then = 65

True = 66

Type = 67

Var = 68

When = 69

With = 70

Xor = 71

Model = 72

Package = 73

Needs = 74

Provides = 75

Uses = 76

Is = 77

Body = 78

End = 79

Include = 80

Str = 81

InlineComment = 82

Comment = 83

Error = 84

Root = 85

IncludeStatement = 86

Children: Include + String

PackageDeclNode = 87

PackageDeclBody = 88

PackageAliasNode = 89

UsesNode = 90

ProvidesListNode = 91

ProvidesNode = 92

ModelDeclNode = 93

IdRefNode = 94

IdNode = 95

PragmaNode = 96

TypedIdsNode = 97

TypedValuedLv6IdNode = 98

NodeNode = 99

NodeProfileNode = 100

ParamsNode = 101

VarDeclNode = 102

ConstantDeclNode = 103

OneConstantDeclNode = 104

TypeDeclNode = 105

OneTypeDeclNode = 106

EnumDeclNode = 107

StructDeclNode = 108

TypeNode = 109

ExternalNodeDeclNode = 110

StaticParamsNode = 111

StaticParamNode = 112

EffectiveNodeNode = 113

StaticArgsNode = 114

StaticArgNode = 115

NamedStaticArgsNode = 116

NamedStaticArgNode = 117

BodyNode = 118

AssertEquationNode = 119

EqualsEquationNode = 120

LeftNode = 121

LeftItemListNode = 122

LeftItemNode = 123

LeftFieldAccessNode = 124

LeftTableAccessNode = 125

SelectNode = 126

StepNode = 127

ExpressionNode = 128

ExpressionListNode = 129

ParExpressionNode = 130

ArrayLiteralExpressionNode = 131

IdentExpressionNode = 132

FbyExpressionNode = 133

CallByPosExpressionNode = 134

ArrayAccessExpressionNode = 135

HatExpressionNode = 136

FieldAccessExpressionNode = 137

NegExpressionNode = 138

PreExpressionNode = 139

CurrentExpressionNode = 140

DieseExpressionNode = 141

NorExpressionNode = 142

IntExpressionNode = 143

RealExpressionNode = 144

WhenExpressionNode = 145

PowerExpressionNode = 146

MulExpressionNode = 147

DivExpressionNode = 148

ModExpressionNode = 149

AddExpressionNode = 150

SubExpressionNode = 151

NotExpressionNode = 152

LtExpressionNode = 153

LteExpressionNode = 154

EqExpressionNode = 155

GteExpressionNode = 156

GtExpressionNode = 157

NeqExpressionNode = 158

AndExpressionNode = 159

OrExpressionNode = 160

XorExpressionNode = 161

ImplExpressionNode = 162

ArrowExpressionNode = 163

ConcatExpressionNode = 164

IfExpressionNode = 165

WithExpressionNode = 166

ClockExpressionNode = 167

MergeExpressionNode = 168

MergeCaseNode = 169

PredefOp = 170

CallByNameExpressionNode = 171

CallByNameParamNode = 172

ConstantNode = 173

Implementations

impl Token

pub fn is_trivia(self) -> bool

Returns true if and only if a token is considered “trivia” (space or comment)

pub fn is_non_trivia(self) -> bool

Returns true if and only if a token is not considered “trivia” (space or comment)

Most tokens are not trivia.

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a copy 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 From<Token> for SyntaxKind

fn from(tok: Token) -> Self

Converts to this type from the input type.

impl Hash for Token

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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 Ord for Token

fn cmp(&self, other: &Token) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl Ordinalize for Token

const VARIANT_COUNT: usize = 174usize

The count of variants.

const VARIANTS: &'static [Self] = _

List of this enum’s variants.

const VALUES: &'static [u16] = _

List of values for all variants of this enum.

type VariantType = u16

The type of the values of the variants.

fn ordinal(&self) -> u16

Retrieve the integer number of this variant.

unsafe fn from_ordinal_unsafe(number: u16) -> Self

Obtain a variant based on an integer number.

fn from_ordinal(number: u16) -> Option<Self>

Obtain a variant based on an integer number.

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 PartialOrd for Token

fn partial_cmp(&self, other: &Token) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Token

impl Eq for Token

impl StructuralPartialEq for Token