SyntaxKind

Enum SyntaxKind 

Source
pub enum SyntaxKind {
Show 68 variants ParenOpen = 0, ParenClose, BracketOpen, BracketClose, BraceOpen, BraceClose, DoubleColon, Colon, Equals, Negation, Minus, Tilde, Underscore, Star, Plus, Question, StarQuestion, PlusQuestion, QuestionQuestion, Slash, Comma, Pipe, DoubleQuote, SingleQuote, StrVal, KwError, KwMissing, Id, Dot, CaptureToken, SuppressiveCapture, At, Whitespace, Newline, LineComment, BlockComment, OpEq, OpNe, OpStartsWith, OpEndsWith, OpContains, OpRegexMatch, OpRegexNoMatch, RegexPredicateMatch, RegexPredicateNoMatch, RegexLiteral, RegexContent, XMLGarbage, TsPredicate, Garbage, Error, Root, Tree, Ref, Str, Field, Capture, Type, Quantifier, Seq, Alt, Branch, Wildcard, Anchor, NegatedField, Def, NodePredicate, Regex, // some variants omitted
}
Expand description

All token and node kinds. Tokens first, then nodes, then __LAST sentinel. #[repr(u16)] enables safe transmute in kind_from_raw.

Variants§

§

ParenOpen = 0

§

ParenClose

§

BracketOpen

§

BracketClose

§

BraceOpen

§

BraceClose

§

DoubleColon

:: for type annotations. Defined before Colon for correct precedence.

§

Colon

§

Equals

§

Negation

§

Minus

§

Tilde

§

Underscore

§

Star

§

Plus

§

Question

§

StarQuestion

Non-greedy *? quantifier

§

PlusQuestion

Non-greedy +? quantifier

§

QuestionQuestion

Non-greedy ?? quantifier

§

Slash

Slash for supertype paths: (expression/binary_expression)

§

Comma

Comma (invalid separator, for error recovery)

§

Pipe

Pipe (invalid separator, for error recovery)

§

DoubleQuote

§

SingleQuote

§

StrVal

String content between quotes

§

KwError

§

KwMissing

§

Id

Identifier. Accepts dots/hyphens for tree-sitter compat; parser validates per context. Defined after keywords so they take precedence.

§

Dot

§

CaptureToken

Regular capture: @name (matches before At)

§

SuppressiveCapture

Suppressive capture: @_ or @_name (matches before At)

§

At

Bare @ (for error recovery: “capture without target”)

§

Whitespace

§

Newline

§

LineComment

§

BlockComment

§

OpEq

== for predicate equals

§

OpNe

!= for predicate not equals

§

OpStartsWith

^= for predicate starts-with

§

OpEndsWith

$= for predicate ends-with

§

OpContains

*= for predicate contains (defined after Star for correct precedence)

§

OpRegexMatch

=~ for predicate regex match (when followed by string or error)

§

OpRegexNoMatch

!~ for predicate regex no-match (when followed by string or error)

§

RegexPredicateMatch

=~ followed by regex literal: =~ /pattern/ Compound token to avoid // being lexed as line comment.

§

RegexPredicateNoMatch

!~ followed by regex literal: !~ /pattern/

§

RegexLiteral

Regex literal token (after splitting compound predicate)

§

RegexContent

Regex pattern content (between slashes, set by parser)

§

XMLGarbage

XML-like tags matched as errors (common LLM output)

§

TsPredicate

Tree-sitter predicates (unsupported)

§

Garbage

Coalesced unrecognized characters

§

Error

§

Root

§

Tree

§

Ref

§

Str

§

Field

§

Capture

§

Type

§

Quantifier

§

Seq

§

Alt

§

Branch

§

Wildcard

§

Anchor

§

NegatedField

§

Def

§

NodePredicate

Predicate on a node: (identifier == "foo")

§

Regex

Regex literal: /pattern/

Implementations§

Source§

impl SyntaxKind

Source

pub fn is_trivia(self) -> bool

Source

pub fn is_error(self) -> bool

Trait Implementations§

Source§

impl Clone for SyntaxKind

Source§

fn clone(&self) -> SyntaxKind

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SyntaxKind

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<SyntaxKind> for SyntaxKind

Source§

fn from(kind: SyntaxKind) -> Self

Converts to this type from the input type.
Source§

impl Hash for SyntaxKind

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<'s> Logos<'s> for SyntaxKind

Source§

type Error = ()

Error type returned by the lexer. This can be set using #[logos(error = MyError)]. Defaults to () if not set.
Source§

type Extras = ()

Associated type Extras for the particular lexer. This can be set using #[logos(extras = MyExtras)] and accessed inside callbacks.
Source§

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].
Source§

fn lex( lex: &mut Lexer<'s, Self>, ) -> Option<Result<Self, <Self as Logos<'s>>::Error>>

The heart of Logos. Called by the Lexer. The implementation for this function is generated by the logos-derive crate.
Source§

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.
Source§

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.
Source§

impl Ord for SyntaxKind

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for SyntaxKind

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for SyntaxKind

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl Copy for SyntaxKind

Source§

impl Eq for SyntaxKind

Source§

impl StructuralPartialEq for SyntaxKind

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.