Struct rowan::api::SyntaxNode
source · [−]pub struct SyntaxNode<L: Language> { /* private fields */ }Implementations
sourceimpl<L: Language> SyntaxNode<L>
impl<L: Language> SyntaxNode<L>
pub fn new_root(green: GreenNode) -> SyntaxNode<L>
sourcepub fn replace_with(&self, replacement: GreenNode) -> GreenNode
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
pub fn kind(&self) -> L::Kind
pub fn text_range(&self) -> TextRange
pub fn index(&self) -> usize
pub fn text(&self) -> SyntaxText
pub fn green(&self) -> Cow<'_, GreenNodeData>
pub fn parent(&self) -> Option<SyntaxNode<L>>
pub fn ancestors(&self) -> impl Iterator<Item = SyntaxNode<L>>
pub fn children(&self) -> SyntaxNodeChildren<L>ⓘNotable traits for SyntaxNodeChildren<L>impl<L: Language> Iterator for SyntaxNodeChildren<L> type Item = SyntaxNode<L>;
pub fn children_with_tokens(&self) -> SyntaxElementChildren<L>ⓘNotable traits for SyntaxElementChildren<L>impl<L: Language> Iterator for SyntaxElementChildren<L> type Item = SyntaxElement<L>;
pub fn first_child(&self) -> Option<SyntaxNode<L>>
pub fn last_child(&self) -> Option<SyntaxNode<L>>
pub fn first_child_or_token(&self) -> Option<SyntaxElement<L>>
pub fn last_child_or_token(&self) -> Option<SyntaxElement<L>>
pub fn next_sibling(&self) -> Option<SyntaxNode<L>>
pub fn prev_sibling(&self) -> Option<SyntaxNode<L>>
pub fn next_sibling_or_token(&self) -> Option<SyntaxElement<L>>
pub fn prev_sibling_or_token(&self) -> Option<SyntaxElement<L>>
sourcepub fn first_token(&self) -> Option<SyntaxToken<L>>
pub fn first_token(&self) -> Option<SyntaxToken<L>>
Return the leftmost token in the subtree of this node.
sourcepub fn last_token(&self) -> Option<SyntaxToken<L>>
pub fn last_token(&self) -> Option<SyntaxToken<L>>
Return the rightmost token in the subtree of this node.
pub fn siblings(
&self,
direction: Direction
) -> impl Iterator<Item = SyntaxNode<L>>
pub fn siblings_with_tokens(
&self,
direction: Direction
) -> impl Iterator<Item = SyntaxElement<L>>
pub fn descendants(&self) -> impl Iterator<Item = SyntaxNode<L>>
pub fn descendants_with_tokens(&self) -> impl Iterator<Item = SyntaxElement<L>>
sourcepub fn preorder(&self) -> Preorder<L>ⓘNotable traits for Preorder<L>impl<L: Language> Iterator for Preorder<L> type Item = WalkEvent<SyntaxNode<L>>;
pub fn preorder(&self) -> Preorder<L>ⓘNotable traits for Preorder<L>impl<L: Language> Iterator for Preorder<L> type Item = WalkEvent<SyntaxNode<L>>;
Traverse the subtree rooted at the current node (including the current node) in preorder, excluding tokens.
sourcepub fn preorder_with_tokens(&self) -> PreorderWithTokens<L>ⓘNotable traits for PreorderWithTokens<L>impl<L: Language> Iterator for PreorderWithTokens<L> type Item = WalkEvent<SyntaxElement<L>>;
pub fn preorder_with_tokens(&self) -> PreorderWithTokens<L>ⓘNotable traits for PreorderWithTokens<L>impl<L: Language> Iterator for PreorderWithTokens<L> type Item = WalkEvent<SyntaxElement<L>>;
Traverse the subtree rooted at the current node (including the current node) in preorder, including tokens.
sourcepub fn token_at_offset(&self, offset: TextSize) -> TokenAtOffset<SyntaxToken<L>>ⓘNotable traits for TokenAtOffset<T>impl<T> Iterator for TokenAtOffset<T> type Item = T;
pub fn token_at_offset(&self, offset: TextSize) -> TokenAtOffset<SyntaxToken<L>>ⓘNotable traits for TokenAtOffset<T>impl<T> Iterator for TokenAtOffset<T> type Item = T;
Find a token in the subtree corresponding to this node, which covers the offset. Precondition: offset must be withing node’s range.
sourcepub fn covering_element(&self, range: TextRange) -> SyntaxElement<L>
pub fn covering_element(&self, range: TextRange) -> SyntaxElement<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
sourcepub fn child_or_token_at_range(
&self,
range: TextRange
) -> Option<SyntaxElement<L>>
pub fn child_or_token_at_range(
&self,
range: TextRange
) -> Option<SyntaxElement<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().
sourcepub fn clone_subtree(&self) -> SyntaxNode<L>
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.
pub fn clone_for_update(&self) -> SyntaxNode<L>
pub fn detach(&self)
pub fn splice_children(
&self,
to_delete: Range<usize>,
to_insert: Vec<SyntaxElement<L>>
)
Trait Implementations
sourceimpl<L: Clone + Language> Clone for SyntaxNode<L>
impl<L: Clone + Language> Clone for SyntaxNode<L>
sourcefn clone(&self) -> SyntaxNode<L>
fn clone(&self) -> SyntaxNode<L>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more