Struct SyntaxToken 

pub struct SyntaxToken { /* private fields */ }

Leaf token in the red syntax tree.

Implementations

impl SyntaxToken

pub fn kind(&self) -> SyntaxKind

Kind of this token.

pub fn text_range(&self) -> TextRange

The range that this token covers in the original text.

pub fn text(&self) -> &str

Text of this token.

pub fn green(&self) -> &GreenToken

The underlying green token of this red token.

pub fn amber(&self) -> AmberToken<'_>

The corresponding amber token of this red token.

pub fn parent(&self) -> SyntaxNode

Parent of this token.

pub fn parent_ancestors(&self) -> impl Iterator<Item = SyntaxNode>

Iterator along the chain of parents of this token.

pub fn next_siblings(&self) -> impl Iterator<Item = SyntaxNode>

Nodes that come immediately after this token.

If you want to iterate over both nodes and tokens, use next_siblings_with_tokens instead.

pub fn next_sibling_or_token( &self, ) -> Option<NodeOrToken<SyntaxNode, SyntaxToken>>

Node or token that comes immediately after this token.

pub fn next_siblings_with_tokens( &self, ) -> impl Iterator<Item = NodeOrToken<SyntaxNode, SyntaxToken>>

Nodes and tokens that come immediately after this token.

Unlike rowan, the iterator doesn’t contain the current token itself.

pub fn next_consecutive_tokens(&self) -> impl Iterator<Item = SyntaxToken>

Consecutive tokens sequence that come immediately after this token without any nodes in between.

pub fn prev_siblings(&self) -> impl Iterator<Item = SyntaxNode>

Nodes that come immediately before this token.

If you want to iterate over both nodes and tokens, use prev_siblings_with_tokens instead.

pub fn prev_sibling_or_token( &self, ) -> Option<NodeOrToken<SyntaxNode, SyntaxToken>>

Node or token that comes immediately before this token.

pub fn prev_siblings_with_tokens( &self, ) -> impl Iterator<Item = NodeOrToken<SyntaxNode, SyntaxToken>>

Nodes and tokens that come immediately before this token.

Unlike rowan, the iterator doesn’t contain the current token itself.

pub fn prev_consecutive_tokens(&self) -> impl Iterator<Item = SyntaxToken>

Consecutive tokens sequence that come immediately before this token without any nodes in between.

Trait Implementations

impl Clone for SyntaxToken

fn clone(&self) -> SyntaxToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxToken

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

Formats the value using the given formatter.

impl Display for SyntaxToken

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

Formats the value using the given formatter.

impl<'a> From<&'a SyntaxToken> for AmberToken<'a>

fn from(token: &'a SyntaxToken) -> Self

Converts to this type from the input type.

impl From<SyntaxToken> for NodeOrToken<SyntaxNode, SyntaxToken>

fn from(token: SyntaxToken) -> Self

Converts to this type from the input type.

impl Hash for SyntaxToken

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 PartialEq for SyntaxToken

fn eq(&self, other: &SyntaxToken) -> 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 Eq for SyntaxToken

impl StructuralPartialEq for SyntaxToken