Struct SyntaxNode 

pub struct SyntaxNode { /* private fields */ }

A node with a position.

Built on demand from a green node plus the offset it sits at and the parent it hangs from. Cheap to make and cheap to drop; nothing caches them.

Implementations

impl SyntaxNode

pub const fn root(green: Arc<GreenNode>) -> Self

The root of a tree.

pub fn kind(&self) -> CstKind

What it is.

pub fn span(&self) -> Span

Where it sits in the file, trivia included.

pub fn green(&self) -> &Arc<GreenNode>

The green node behind it.

pub fn parent(&self) -> Option<&Arc<Self>>

Its parent, if it is not the root.

pub fn ancestors(&self) -> Vec<Arc<Self>>

The chain from this node up to the root, this node first.

pub fn children(self: &Arc<Self>) -> Vec<Arc<Self>>

Its child nodes, with their positions filled in.

pub fn tokens(&self) -> Vec<(Span, GreenToken)>

Its direct tokens, with their positions.

pub fn syntax_tokens(&self) -> Vec<(Span, GreenToken)>

The node’s own tokens with the trivia left out.

SyntaxNode::tokens keeps everything, because the round trip needs it. A rule asking what a node says wants this one: the first token of @ key is @, and the one after it is key, not the space between them.

pub fn text(&self) -> String

Reconstruct the source this node covers.

pub fn descendants(self: &Arc<Self>) -> Vec<Arc<Self>>

Every node in the subtree, this one first, in source order.

pub fn has_errors(self: &Arc<Self>) -> bool

Whether this node or any below it came from recovery.

Trait Implementations

impl Clone for SyntaxNode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxNode

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

Formats the value using the given formatter.

impl Display for SyntaxNode

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

Formats the value using the given formatter.