Struct LinkedNode

pub struct LinkedNode<'a> { /* private fields */ }

A syntax node in a context.

Knows its exact offset in the file and provides access to its children, parent and siblings.

Note that all sibling and leaf accessors skip over trivia!

Implementations

impl<'a> LinkedNode<'a>

pub fn new(root: &'a SyntaxNode) -> Self

Start a new traversal at a root node.

pub fn get(&self) -> &'a SyntaxNode

Get the contained syntax node.

pub fn index(&self) -> usize

The index of this node in its parent’s children list.

pub fn offset(&self) -> usize

The absolute byte offset of this node in the source file.

pub fn range(&self) -> Range<usize>

The byte range of this node in the source file.

pub fn children(&self) -> LinkedChildren<'a>

An iterator over this node’s children.

pub fn find(&self, span: Span) -> Option<LinkedNode<'a>>

Find a descendant with the given span.

impl<'a> LinkedNode<'a>

Access to parents and siblings.

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

Get this node’s parent.

pub fn prev_sibling(&self) -> Option<Self>

Get the first previous non-trivia sibling node.

pub fn next_sibling(&self) -> Option<Self>

Get the next non-trivia sibling node.

pub fn parent_kind(&self) -> Option<SyntaxKind>

Get the kind of this node’s parent.

pub fn prev_sibling_kind(&self) -> Option<SyntaxKind>

Get the kind of this node’s first previous non-trivia sibling.

pub fn next_sibling_kind(&self) -> Option<SyntaxKind>

Get the kind of this node’s next non-trivia sibling.

impl<'a> LinkedNode<'a>

Access to leaves.

pub fn prev_leaf(&self) -> Option<Self>

Get the rightmost non-trivia leaf before this node.

pub fn leftmost_leaf(&self) -> Option<Self>

Find the leftmost contained non-trivia leaf.

pub fn leaf_at(&self, cursor: usize, side: Side) -> Option<Self>

Get the leaf at the specified byte offset.

pub fn rightmost_leaf(&self) -> Option<Self>

Find the rightmost contained non-trivia leaf.

pub fn next_leaf(&self) -> Option<Self>

Get the leftmost non-trivia leaf after this node.

Methods from Deref<Target = SyntaxNode>

pub fn kind(&self) -> SyntaxKind

The type of the node.

pub fn is_empty(&self) -> bool

Return true if the length is 0.

pub fn len(&self) -> usize

The byte length of the node in the source text.

pub fn span(&self) -> Span

The span of the node.

pub fn text(&self) -> &EcoString

The text of the node if it is a leaf or error node.

Returns the empty string if this is an inner node.

pub fn children(&self) -> Iter<'_, SyntaxNode>

The node’s children.

pub fn is<'a, T: AstNode<'a>>(&'a self) -> bool

Whether the node can be cast to the given AST node.

pub fn cast<'a, T: AstNode<'a>>(&'a self) -> Option<T>

Try to convert the node to a typed AST node.

pub fn cast_first_match<'a, T: AstNode<'a>>(&'a self) -> Option<T>

Cast the first child that can cast to the AST type T.

pub fn cast_last_match<'a, T: AstNode<'a>>(&'a self) -> Option<T>

Cast the last child that can cast to the AST type T.

pub fn erroneous(&self) -> bool

Whether the node or its children contain an error.

pub fn errors(&self) -> Vec<SyntaxError>

The error messages for this node and its descendants.

pub fn spanless_eq(&self, other: &Self) -> bool

Whether the two syntax nodes are the same apart from spans.

Trait Implementations

impl<'a> Clone for LinkedNode<'a>

fn clone(&self) -> LinkedNode<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LinkedNode<'_>

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

Formats the value using the given formatter.

impl Deref for LinkedNode<'_>

fn deref(&self) -> &Self::Target

Dereference to a syntax node. Note that this shortens the lifetime, so you may need to use get() instead in some situations.

type Target = SyntaxNode

The resulting type after dereferencing.