Enum SyntaxKind 

#[non_exhaustive]
pub enum SyntaxKind {
    Whitespace = 0,
    Bom,
    LineComment,
    BlockComment,
    Ident,
    Integer,
    Float,
    String,
    RawString,
    Char,
    TrueKw,
    FalseKw,
    LParen,
    RParen,
    LBracket,
    RBracket,
    LBrace,
    RBrace,
    Colon,
    Comma,
    Hash,
    Bang,
    EnableKw,
    LexError,
    Root,
    Struct,
    StructField,
    Tuple,
    List,
    Map,
    MapEntry,
    EnumVariant,
    Unit,
    Literal,
    ExtensionAttr,
    Error,
}

Closed classification of every CST node and token.

#[repr(u16)] with explicit, stable discriminants so the mapping to/from rowan’s raw kind is total and order-independent. New variants MUST be added before SyntaxKind::__Last and existing discriminants MUST NOT be renumbered (the value is part of the on-tree representation).

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.

Whitespace = 0

Run of ASCII/Unicode whitespace (spaces, tabs, newlines — CR and LF preserved verbatim).

Bom

A leading UTF-8 byte-order mark (\u{FEFF}), kept as trivia (AD-008).

LineComment

Line comment: // ... up to (but not including) the line break.

BlockComment

Block comment: /* ... */, nestable.

Ident

Bare identifier or struct/variant/field name (e.g. Foo, x).

Integer

Integer literal (any base, with optional _ separators / type suffix).

Float

Floating-point literal (with optional _ separators / type suffix).

String

Normal string literal "..." (with escapes), verbatim including quotes.

RawString

Raw string literal r#"..."#, verbatim including delimiters.

Char

Character literal 'c' (with escapes), verbatim including quotes.

TrueKw

The true keyword token.

FalseKw

The false keyword token.

LParen

(

RParen

)

LBracket

[

RBracket

]

LBrace

{

RBrace

}

Colon

:

Comma

,

Hash

#

Bang

!

EnableKw

enable keyword inside an extension attribute.

LexError

Any byte run the lexer could not classify (recovery sentinel token). Always wrapped in an SyntaxKind::Error node by the parser.

Root

The document root node. Holds the single top-level value plus any leading extension attributes and surrounding trivia.

Struct

Named struct Name( field: value, ... ) or anonymous struct ( field: value, ... ).

StructField

A single field: value entry inside a SyntaxKind::Struct.

Tuple

Tuple / tuple-struct ( a, b, c ) (positional, no field names).

List

List / sequence [ a, b, c ].

Map

Map { k: v, ... } (keys may be non-string values).

MapEntry

A single key: value entry inside a SyntaxKind::Map.

EnumVariant

Enum variant: a bare Ident, or Ident(...) / Ident{...} payload.

Unit

Unit value ().

Literal

Wrapper around a scalar literal token so scalar values are uniform nodes.

ExtensionAttr

Extension attribute #![enable(ext, ...)]. Unknown extensions are still preserved verbatim as text within this node.

Error

Recovery node wrapping unexpected/unparseable tokens so the tree still covers all input (TR-005/INV-3).

Implementations

impl SyntaxKind

pub fn is_trivia(self) -> bool

true for trivia token kinds (whitespace, comments, BOM).

Trivia is semantically inert but preserved verbatim for losslessness (AD-001). Used by the printer/accessors, never alters byte coverage.

pub fn is_token(self) -> bool

true if this kind classifies a token (leaf) rather than a node.

Trait Implementations

impl Clone for SyntaxKind

fn clone(&self) -> SyntaxKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SyntaxKind

impl Debug for SyntaxKind

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

Formats the value using the given formatter.

impl Eq for SyntaxKind

impl Hash for SyntaxKind

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

fn cmp(&self, other: &SyntaxKind) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for SyntaxKind

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SyntaxKind

fn partial_cmp(&self, other: &SyntaxKind) -> 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 StructuralPartialEq for SyntaxKind