Struct SyntaxNode 

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

SyntaxNode. Untyped view of the syntax tree. Adds parent() and offset() capabilities.

This is a public wrapper around a private tracked struct. Construction only happens through tracked functions to ensure uniqueness of SyntaxNodes. Use SyntaxNode::new_root or SyntaxNode::new_root_with_offset to create root nodes.

Implementations

impl<'db> SyntaxNode<'db>

pub fn offset(self, db: &'db dyn Database) -> TextOffset

Get the offset of this syntax node from the beginning of the file.

pub fn parent(self, db: &'db dyn Database) -> Option<SyntaxNode<'db>>

Get the parent syntax node, if any.

pub fn grandparent(self, db: &'db dyn Database) -> Option<SyntaxNode<'db>>

Get the grandparent syntax node, if any. This uses a cached parent when available, avoiding some database lookups.

pub fn is_root(self) -> bool

Check if this syntax node is the root of the syntax tree.

pub fn stable_ptr(self, _db: &'db dyn Database) -> SyntaxStablePtrId<'db>

Get the stable pointer for this syntax node.

pub fn raw_id(&self, db: &'db dyn Database) -> &'db SyntaxNodeId<'db>

pub fn key_fields(self, db: &'db dyn Database) -> &'db [GreenId<'db>]

Get the key fields of this syntax node. These define the unique identifier of the node.

pub fn file_id(&self, db: &'db dyn Database) -> FileId<'db>

Returns the file id of the file containing this node.

pub fn nth_parent<'r: 'db>( &self, db: &'r dyn Database, n: usize, ) -> SyntaxNode<'db>

Returns the stable pointer of the nth parent of this stable pointer. n = 0: returns itself. n = 1: return the parent. n = 2: return the grand parent. And so on… Assumes that the nth parent exists. Panics otherwise.

impl<'a> SyntaxNode<'a>

pub fn new_root( db: &'a dyn Database, file_id: FileId<'a>, green: GreenId<'a>, ) -> Self

Create a new root syntax node.

pub fn new_root_with_offset( db: &'a dyn Database, file_id: FileId<'a>, green: GreenId<'a>, initial_offset: Option<TextOffset>, ) -> Self

Create a new root syntax node with a custom initial offset.

pub fn width(&self, db: &dyn Database) -> TextWidth

Get the width of this syntax node.

pub fn kind(&self, _db: &dyn Database) -> SyntaxKind

Get the syntax kind of this node.

pub fn span(&self, db: &dyn Database) -> TextSpan

Get the span of this syntax node.

pub fn text(&self, db: &'a dyn Database) -> Option<SmolStrId<'a>>

Returns the text of the token if this node is a token.

pub fn green_node(&self, db: &'a dyn Database) -> &'a GreenNode<'a>

Returns the green node of the syntax node.

pub fn span_without_trivia(&self, db: &dyn Database) -> TextSpan

Returns the span of the syntax node without trivia.

pub fn get_terminal_token( &'a self, db: &'a dyn Database, ) -> Option<SyntaxNode<'a>>

Gets the inner token from a terminal SyntaxNode. If the given node is not a terminal, returns None.

pub fn get_children(&self, db: &'a dyn Database) -> &'a [SyntaxNode<'a>]

Gets the children syntax nodes of the current node.

pub fn span_start_without_trivia(&self, db: &dyn Database) -> TextOffset

Returns the start of the span of the syntax node without trivia.

pub fn span_end_without_trivia(&self, db: &dyn Database) -> TextOffset

Returns the end of the span of the syntax node without trivia.

pub fn lookup_offset( &self, db: &'a dyn Database, offset: TextOffset, ) -> SyntaxNode<'a>

Lookups a syntax node using an offset.

pub fn lookup_position( &self, db: &'a dyn Database, position: TextPosition, ) -> SyntaxNode<'a>

Lookups a syntax node using a position.

pub fn get_text(&self, db: &'a dyn Database) -> &'a str

Returns all the text under the syntax node.

pub fn get_text_without_inner_commentable_children( &self, db: &dyn Database, ) -> String

Returns all the text under the syntax node. It traverses all the syntax tree of the node, but ignores functions and modules. We ignore those, because if there’s some inner functions or modules, we don’t want to get raw text of them. Comments inside them refer themselves directly, not this SyntaxNode.

pub fn get_text_without_all_comment_trivia(&self, db: &dyn Database) -> String

Returns all the text of the item without comments trivia. It traverses all the syntax tree of the node.

pub fn get_text_without_trivia(self, db: &'a dyn Database) -> SmolStrId<'a>

Returns all the text under the syntax node, without the outmost trivia (the leading trivia of the first token and the trailing trivia of the last token).

Note that this traverses the syntax tree, and generates a new string, so use responsibly.

pub fn get_text_of_span(self, db: &'a dyn Database, span: TextSpan) -> &'a str

Returns the text under the syntax node, according to the given span.

span is assumed to be contained within the span of self.

Note that this traverses the syntax tree, and generates a new string, so use responsibly.

pub fn descendants( &self, db: &'a dyn Database, ) -> impl Iterator<Item = SyntaxNode<'a>> + 'a

Traverse the subtree rooted at the current node (including the current node) in preorder.

This is a shortcut for Self::preorder paired with filtering for WalkEvent::Enter events only.

pub fn preorder(&self, db: &'a dyn Database) -> Preorder<'a>

Traverse the subtree rooted at the current node (including the current node) in preorder, excluding tokens.

pub fn tokens(&self, db: &'a dyn Database) -> impl Iterator<Item = Self> + 'a

Gets all the leaves of the SyntaxTree, where the self node is the root of a tree.

pub fn cast<T: TypedSyntaxNode<'a>>(self, db: &'a dyn Database) -> Option<T>

Mirror of TypedSyntaxNode::cast.

pub fn ancestors( &self, db: &'a dyn Database, ) -> impl Iterator<Item = SyntaxNode<'a>> + 'a

Creates an iterator that yields ancestors of this syntax node.

pub fn ancestors_with_self( &self, db: &'a dyn Database, ) -> impl Iterator<Item = SyntaxNode<'a>> + 'a

Creates an iterator that yields this syntax node and walks up its ancestors.

pub fn is_ancestor(&self, db: &dyn Database, node: &SyntaxNode<'_>) -> bool

Checks whether this syntax node is strictly above the given syntax node in the syntax tree.

pub fn is_descendant(&self, db: &dyn Database, node: &SyntaxNode<'_>) -> bool

Checks whether this syntax node is strictly under the given syntax node in the syntax tree.

pub fn is_ancestor_or_self( &self, db: &dyn Database, node: &SyntaxNode<'_>, ) -> bool

Checks whether this syntax node is or is above the given syntax node in the syntax tree.

pub fn is_descendant_or_self( &self, db: &dyn Database, node: &SyntaxNode<'_>, ) -> bool

Checks whether this syntax node is or is under the given syntax node in the syntax tree.

pub fn ancestor_of_kind( &self, db: &'a dyn Database, kind: SyntaxKind, ) -> Option<SyntaxNode<'a>>

Finds the first ancestor of a given kind.

pub fn ancestor_of_type<T: TypedSyntaxNode<'a>>( &self, db: &'a dyn Database, ) -> Option<T>

Finds the first ancestor of a given kind and returns it in typed form.

pub fn parent_of_kind( &self, db: &'a dyn Database, kind: SyntaxKind, ) -> Option<SyntaxNode<'a>>

Finds the parent of a given kind.

pub fn parent_of_type<T: TypedSyntaxNode<'a>>( &self, db: &'a dyn Database, ) -> Option<T>

Finds the parent of a given kind and returns it in typed form.

pub fn ancestor_of_kinds( &self, db: &'a dyn Database, kinds: &[SyntaxKind], ) -> Option<SyntaxNode<'a>>

Finds the first parent of one of the kinds.

pub fn parent_kind(&self, _db: &dyn Database) -> Option<SyntaxKind>

Gets the kind of the given node’s parent if it exists.

pub fn grandparent_kind(&self, db: &dyn Database) -> Option<SyntaxKind>

Gets the kind of the given node’s grandparent if it exists.

pub fn grandgrandparent_kind(&self, db: &dyn Database) -> Option<SyntaxKind>

Gets the kind of the given node’s grandgrandparent if it exists.

Trait Implementations

impl<'a> Clone for SyntaxNode<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'db> Debug for SyntaxNode<'db>

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

Formats the value using the given formatter.

impl<'db> DebugWithDb<'db> for SyntaxNode<'db>

type Db = dyn Database

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

fn debug<'me>(&'me self, db: &'db Self::Db) -> DebugWith<'me, 'db, Self::Db>

where Self: Sized + 'me,

fn into_debug<'me>(self, db: &'db Self::Db) -> DebugWith<'me, 'db, Self::Db>

where Self: Sized + 'me,

impl<'a> Hash for SyntaxNode<'a>

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<'a> PartialEq for SyntaxNode<'a>

fn eq(&self, other: &SyntaxNode<'a>) -> 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<'a> QueryAttrs<'a> for SyntaxNode<'a>

Allows querying attributes of a syntax node, any typed node which QueryAttrs is implemented for should be added here.

fn attributes_elements( &self, db: &'a dyn Database, ) -> impl Iterator<Item = Attribute<'a>>

Generic call to self.attributes(db).elements(db).

fn query_attr( &self, db: &'a dyn Database, attr: &'a str, ) -> impl Iterator<Item = Attribute<'a>>

Collect all attributes named exactly attr attached to this node.

fn find_attr( &self, db: &'a dyn Database, attr: &'a str, ) -> Option<Attribute<'a>>

Find first attribute named exactly attr attached to this node.

fn has_attr(&self, db: &'a dyn Database, attr: &'a str) -> bool

Check if this node has an attribute named exactly attr.

fn has_attr_with_arg( &self, db: &'a dyn Database, attr_name: &'a str, arg_name: &str, ) -> bool

Checks if the given object has an attribute with the given name and argument.

impl<'a> Update for SyntaxNode<'a>

unsafe fn maybe_update(old_pointer_: *mut Self, new_value_: Self) -> bool

Returns

impl<'a> Copy for SyntaxNode<'a>

impl<'a> Eq for SyntaxNode<'a>

impl<'a> StructuralPartialEq for SyntaxNode<'a>