Enum TokenKind 

pub enum TokenKind {
    Commons,
    Type,
    Fn,
    Where,
    And,
    True,
    False,
    Int,
    String,
    Bool,
    Float,
    Duration,
    Instant,
    Bytes,
    Let,
    If,
    Else,
    Ok,
    Err,
    Result,
    ValidationError,
    JsonError,
    Enum,
    Match,
    Option,
    Record,
    Self_,
    Some,
    None,
    Is,
    Opaque,
    Uses,
    Context,
    Consumes,
    Exports,
    Transparent,
    As,
    Expect,
    Mocks,
    Suite,
    Case,
    Property,
    Wires,
    Adapter,
    Binding,
    Agent,
    Capability,
    Effect,
    Given,
    On,
    Http,
    Cron,
    Queue,
    From,
    Protocol,
    Provides,
    Service,
    Actor,
    By,
    Invariant,
    Implies,
    DotDotDot,
    LArrow,
    TildeArrow,
    ColonEq,
    DocBlock,
    Comment,
    Ident,
    IntLit,
    FloatLit,
    StrLit,
    InterpStr,
    Arrow,
    EqEq,
    BangEq,
    LtEq,
    GtEq,
    AmpAmp,
    PipePipe,
    Plus,
    Minus,
    Star,
    Slash,
    Bang,
    Eq,
    Lt,
    Gt,
    Question,
    FatArrow,
    Underscore,
    Pipe,
    At,
    LParen,
    RParen,
    LBrace,
    RBrace,
    LBracket,
    RBracket,
    Comma,
    Colon,
    Dot,
}

Token kinds. Discriminants without payload data; the lexeme is recovered from the source string via the token’s Span.

Note: -- line comments and --- doc block markers are handled outside logos (see tokenize), because doc blocks are delimited by --- lines containing only the marker and may span multiple source lines.

Variants

Commons

Type

Fn

Where

And

True

False

Int

String

Bool

Float

Duration

Instant

Bytes

Let

If

Else

Ok

Err

Result

ValidationError

JsonError

Enum

Match

Option

Record

Self_

Some

None

Is

Opaque

Uses

Context

Consumes

Exports

Transparent

As

Expect

Mocks

Suite

Case

Property

Wires

Adapter

Binding

Agent

Capability

Effect

Given

On

Http

Cron

Queue

From

Protocol

Provides

Service

Actor

By

Invariant

Implies

DotDotDot

... — used in record-spread expressions (v0.5).

LArrow

<- — Effect bind operator (v0.5).

TildeArrow

~> — asynchronous fire-and-forget send marker (v0.79). A leading statement marker, never on the RHS of a let; distinct from <- so the call site shows whether the caller waits.

ColonEq

:= — Cell write (v0.81, storage track). A handler statement cell := expr; distinct from = (binding) and : (annotation). Longer than :/= so logos matches it as one token.

DocBlock

A documentation block: --- line … --- line. The token’s span covers the full block including both --- markers. The body content is recovered from the source via the span (see doc_block_content). Inserted by tokenize; not lexed by logos directly.

Comment

A line comment: -- ... running to end of line. The span starts at the -- marker and runs through the last character before the terminating newline (exclusive). The trivia body (the text after the -- marker) is recovered from the source via the span. Inserted by tokenize; not lexed by logos directly so it cannot be mistaken for an -- operator sequence.

Ident

IntLit

FloatLit

StrLit

InterpStr

Arrow

EqEq

BangEq

LtEq

GtEq

AmpAmp

PipePipe

Plus

Minus

Star

Slash

Bang

Eq

Lt

Gt

Question

FatArrow

Underscore

Pipe

At

@ — storage-annotation marker (v0.85, storage track; ADR 0111). Leads a @name(args) annotation on a store field (@ttl(…)/@indexed(…)); it appears only in store-field-declaration position, never as an expression operator.

LParen

RParen

LBrace

RBrace

LBracket

RBracket

Comma

Colon

Dot

Implementations

impl TokenKind

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

Human-readable display name for diagnostics.

Trait Implementations

impl Clone for TokenKind

fn clone(&self) -> TokenKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenKind

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

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, TokenKind>, ) -> Option<Result<TokenKind, <TokenKind as Logos<'s>>::Error>>

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

impl Eq for TokenKind

impl StructuralPartialEq for TokenKind