Enum Token 

#[non_exhaustive]
pub enum Token {
    Keyword(Keyword, Span),
    IntLit(i64, Span),
    FloatLit(f64, Span),
    StrLit(String, Span),
    BoolLit(bool, Span),
    NullLit(Span),
    Ident(String, Span),
    Param(String, Span),
    LParen(Span),
    RParen(Span),
    LBracket(Span),
    RBracket(Span),
    LBrace(Span),
    RBrace(Span),
    Dot(Span),
    Comma(Span),
    Colon(Span),
    Semi(Span),
    Pipe(Span),
    DotDot(Span),
    Eq(Span),
    Neq(Span),
    Lt(Span),
    Lte(Span),
    Gt(Span),
    Gte(Span),
    Plus(Span),
    Minus(Span),
    Star(Span),
    Slash(Span),
    Percent(Span),
    Caret(Span),
    RegexMatch(Span),
    Whitespace(Span),
    Comment(String, Span),
    Eof(Span),
}

A lexed token emitted by the GraphForge Cypher lexer.

Every variant carries a Span so that downstream consumers can report precise error locations. The lexer never omits the span — not even for whitespace tokens that the parser would normally discard.

Stability

This enum is #[non_exhaustive]. Parsers and test harnesses must match only the variants they care about and use a wildcard arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Keyword(Keyword, Span)

A reserved keyword (case-insensitive in openCypher).

IntLit(i64, Span)

A decimal or hexadecimal integer literal.

FloatLit(f64, Span)

A floating-point literal.

StrLit(String, Span)

A single- or double-quoted string literal (escape sequences resolved).

BoolLit(bool, Span)

true or false (also surfaced as Keyword::True/False for parity).

NullLit(Span)

The null literal.

Ident(String, Span)

An unquoted or backtick-quoted identifier.

Param(String, Span)

A Cypher parameter: $name or $0.

LParen(Span)

(

RParen(Span)

)

LBracket(Span)

[

RBracket(Span)

]

LBrace(Span)

{

RBrace(Span)

}

Dot(Span)

.

Comma(Span)

,

Colon(Span)

:

Semi(Span)

;

Pipe(Span)

|

DotDot(Span)

.. (variable-length relationship range separator)

Eq(Span)

=

Neq(Span)

<> or !=

Lt(Span)

<

Lte(Span)

<=

Gt(Span)

>

Gte(Span)

>=

Plus(Span)

+

Minus(Span)

-

Star(Span)

*

Slash(Span)

/

Percent(Span)

%

Caret(Span)

^

RegexMatch(Span)

=~ (regular expression match)

Whitespace(Span)

Whitespace (space, tab, newline).

Comment(String, Span)

A single- or multi-line comment.

Eof(Span)

End of input.

Implementations

impl Token

pub fn span(&self) -> Span

Return the Span of this token.

pub fn is_trivia(&self) -> bool

Return true if this token is trivia (whitespace or comment) that the parser should skip.

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<'de> Deserialize<'de> for Token

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Token

fn eq(&self, other: &Token) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Token

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Token