Struct SyntaxNode

Source

pub struct SyntaxNode {
    pub node: SyntaxNode<Language>,
    pub source_file: SourceFile,
}

Fields§

§node: SyntaxNode<Language>§source_file: SourceFile

Implementations§

Source §

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

Methods from Deref<Target = SyntaxNode<Language>>§

Source

pub fn replace_with(&self, replacement: GreenNode) -> GreenNode

Returns a green tree, equal to the green tree this node belongs two, except with this node substitute. The complexity of operation is proportional to the depth of the tree

Source

pub fn kind(&self) -> <L as Language>::Kind

Source

pub fn text_range(&self) -> TextRange

Source

pub fn index(&self) -> usize

Source

pub fn text(&self) -> SyntaxText

Source

pub fn green(&self) -> Cow<'_, GreenNodeData>

Source

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

Source

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

Source

pub fn children(&self) -> SyntaxNodeChildren<L>

Source

pub fn children_with_tokens(&self) -> SyntaxElementChildren<L>

Source

pub fn first_child(&self) -> Option<SyntaxNode<L>>

Source

pub fn last_child(&self) -> Option<SyntaxNode<L>>

Source

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

Source

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

Source

pub fn next_sibling(&self) -> Option<SyntaxNode<L>>

Source

pub fn prev_sibling(&self) -> Option<SyntaxNode<L>>

Source

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

Source

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

Source

pub fn first_token(&self) -> Option<SyntaxToken<L>>

Return the leftmost token in the subtree of this node.

Source

pub fn last_token(&self) -> Option<SyntaxToken<L>>

Return the rightmost token in the subtree of this node.

Source

pub fn siblings( &self, direction: Direction, ) -> impl Iterator<Item = SyntaxNode<L>>

Source

pub fn siblings_with_tokens( &self, direction: Direction, ) -> impl Iterator<Item = NodeOrToken<SyntaxNode<L>, SyntaxToken<L>>>

Source

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

Source

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

Source

pub fn preorder(&self) -> Preorder<L>

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

Source

pub fn preorder_with_tokens(&self) -> PreorderWithTokens<L>

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

Source

pub fn token_at_offset(&self, offset: TextSize) -> TokenAtOffset<SyntaxToken<L>>

Find a token in the subtree corresponding to this node, which covers the offset. Precondition: offset must be withing node’s range.

Source

pub fn covering_element( &self, range: TextRange, ) -> NodeOrToken<SyntaxNode<L>, SyntaxToken<L>>

Return the deepest node or token in the current subtree that fully contains the range. If the range is empty and is contained in two leaf nodes, either one can be returned. Precondition: range must be contained withing the current node

Source

pub fn child_or_token_at_range( &self, range: TextRange, ) -> Option<NodeOrToken<SyntaxNode<L>, SyntaxToken<L>>>

Finds a SyntaxElement which intersects with a given range. If there are several intersecting elements, any one can be returned.

The method uses binary search internally, so it’s complexity is O(log(N)) where N = self.children_with_tokens().count().

Source

pub fn clone_subtree(&self) -> SyntaxNode<L>

Returns an independent copy of the subtree rooted at this node.

The parent of the returned node will be None, the start offset will be zero, but, otherwise, it’ll be equivalent to the source node.

Source

pub fn clone_for_update(&self) -> SyntaxNode<L>

Source

pub fn detach(&self)

Source

pub fn splice_children( &self, to_delete: Range<usize>, to_insert: Vec<NodeOrToken<SyntaxNode<L>, SyntaxToken<L>>>, )

Trait Implementations§

Source §

impl Clone for SyntaxNode

Source §

fn clone(&self) -> SyntaxNode

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for SyntaxNode

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Deref for SyntaxNode

Source §

type Target = SyntaxNode<Language>

The resulting type after dereferencing.

Source §

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

Dereferences the value.

Source §