Struct SyntaxNode

pub struct SyntaxNode(/* private fields */);

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

Implementations

impl SyntaxNode

pub fn new_root(db: &dyn SyntaxGroup, file_id: FileId, green: GreenId) -> Self

pub fn offset(&self) -> TextOffset

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

pub fn kind(&self, db: &dyn SyntaxGroup) -> SyntaxKind

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

pub fn text(&self, db: &dyn SyntaxGroup) -> Option<SmolStr>

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

pub fn green_node(&self, db: &dyn SyntaxGroup) -> Arc<GreenNode>

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

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

pub fn position_in_parent(&self, db: &dyn SyntaxGroup) -> Option<usize>

Returns the position of a syntax node in its parent’s children, or None if the node has no parent.

pub fn stable_ptr(&self) -> SyntaxStablePtrId

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

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

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

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

pub fn lookup_offset( &self, db: &dyn SyntaxGroup, offset: TextOffset, ) -> SyntaxNode

Lookups a syntax node using an offset.

pub fn lookup_position( &self, db: &dyn SyntaxGroup, position: TextPosition, ) -> SyntaxNode

Lookups a syntax node using a position.

pub fn get_text(&self, db: &dyn SyntaxGroup) -> String

Returns all the text under the syntax node. Note that this traverses the syntax tree, and generates a new string, so use responsibly.

pub fn get_text_without_inner_commentable_children( &self, db: &dyn SyntaxGroup, ) -> 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 SyntaxGroup, ) -> 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: &dyn SyntaxGroup) -> String

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: &dyn SyntaxGroup, span: TextSpan) -> String

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<'db>( &self, db: &'db dyn SyntaxGroup, ) -> impl Iterator<Item = SyntaxNode> + 'db

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<'db>(&self, db: &'db dyn SyntaxGroup) -> Preorder<'db>

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

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

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

Trait Implementations

impl Clone for SyntaxNode

fn clone(&self) -> SyntaxNode

Returns a copy 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 Hash for SyntaxNode

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 SyntaxNode

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

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

fn query_attr(&self, db: &dyn SyntaxGroup, attr: &str) -> Vec<Attribute>

Collect all attributes named exactly attr attached to this node.

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

Find first attribute named exactly attr attached do this node.

fn has_attr(&self, db: &dyn SyntaxGroup, attr: &str) -> bool

Check if this node has an attribute named exactly attr.

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

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

impl Eq for SyntaxNode

impl StructuralPartialEq for SyntaxNode