Struct Node

pub struct Node<'r, D: Doc> { /* private fields */ }

’r represents root lifetime

Implementations

impl<'r, L: LanguageExt> Node<'r, StrDoc<L>>

these methods are only for StrDoc

pub fn replace_all<M: Matcher, R: Replacer<StrDoc<L>>>( &self, matcher: M, replacer: R, ) -> Vec<Edit<String>>

impl<'r, D: Doc> Node<'r, D>

APIs for Node inspection

pub fn get_doc(&self) -> &'r D

pub fn node_id(&self) -> usize

pub fn is_leaf(&self) -> bool

pub fn is_named_leaf(&self) -> bool

if has no named children. N.B. it is different from is_named && is_leaf

pub fn is_error(&self) -> bool

pub fn kind(&self) -> Cow<'_, str>

pub fn kind_id(&self) -> u16

pub fn is_named(&self) -> bool

pub fn is_missing(&self) -> bool

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

byte offsets of start and end.

pub fn start_pos(&self) -> Position

Nodes’ start position in terms of zero-based rows and columns.

pub fn end_pos(&self) -> Position

Nodes’ end position in terms of rows and columns.

pub fn text(&self) -> Cow<'r, str>

pub fn lang(&self) -> &'r D::Lang

pub fn get_inner_node(&self) -> D::Node<'r>

the underlying tree-sitter Node

pub fn root(&self) -> &'r Root<D>

impl<D: Doc> Node<'_, D>

Corresponds to inside/has/precedes/follows

pub fn matches<M: Matcher>(&self, m: M) -> bool

pub fn inside<M: Matcher>(&self, m: M) -> bool

pub fn has<M: Matcher>(&self, m: M) -> bool

pub fn precedes<M: Matcher>(&self, m: M) -> bool

pub fn follows<M: Matcher>(&self, m: M) -> bool

impl<'r, D: Doc> Node<'r, D>

tree traversal API

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

pub fn children(&self) -> impl ExactSizeIterator<Item = Node<'r, D>> + '_

pub fn child(&self, nth: usize) -> Option<Self>

pub fn field(&self, name: &str) -> Option<Self>

pub fn child_by_field_id(&self, field_id: u16) -> Option<Self>

pub fn field_children( &self, name: &str, ) -> impl Iterator<Item = Node<'r, D>> + '_

pub fn ancestors(&self) -> impl Iterator<Item = Node<'r, D>> + '_

Returns all ancestors nodes of self. Using cursor is overkill here because adjust cursor is too expensive.

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

pub fn next_all(&self) -> impl Iterator<Item = Node<'r, D>> + '_

Returns all sibling nodes next to self.

pub fn prev(&self) -> Option<Node<'r, D>>

pub fn prev_all(&self) -> impl Iterator<Item = Node<'r, D>> + '_

pub fn dfs<'s>(&'s self) -> impl Iterator<Item = Node<'r, D>> + 's

pub fn find<M: Matcher>(&self, pat: M) -> Option<NodeMatch<'r, D>>

pub fn find_all<'s, M: Matcher + 's>( &'s self, pat: M, ) -> impl Iterator<Item = NodeMatch<'r, D>> + 's

impl<D: Doc> Node<'_, D>

Tree manipulation API

pub fn replace<M: Matcher, R: Replacer<D>>( &self, matcher: M, replacer: R, ) -> Option<Edit<<D as Doc>::Source>>

pub fn after(&self) -> Edit<<D as Doc>::Source>

pub fn before(&self) -> Edit<<D as Doc>::Source>

pub fn append(&self) -> Edit<<D as Doc>::Source>

pub fn prepend(&self) -> Edit<<D as Doc>::Source>

pub fn empty(&self) -> Option<Edit<<D as Doc>::Source>>

Empty children. Remove all child node

pub fn remove(&self) -> Edit<<D as Doc>::Source>

Remove the node itself

Trait Implementations

impl<'tree, D: Doc> Borrow<Node<'tree, D>> for NodeMatch<'tree, D>

NodeMatch is an immutable view to Node

fn borrow(&self) -> &Node<'tree, D>

Immutably borrows from an owned value.

impl<'r, D: Clone + Doc> Clone for Node<'r, D>

where D::Node<'r>: Clone,

fn clone(&self) -> Node<'r, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'r, D: Doc> From<Node<'r, D>> for Pattern

fn from(node: Node<'r, D>) -> Self

Converts to this type from the input type.

impl<'r, D: Doc> From<Node<'r, D>> for PatternNode

fn from(node: Node<'r, D>) -> Self

Converts to this type from the input type.

impl<'tree, D: Doc> From<Node<'tree, D>> for NodeMatch<'tree, D>

fn from(node: Node<'tree, D>) -> Self

Converts to this type from the input type.

impl<'tree, D: Doc> From<NodeMatch<'tree, D>> for Node<'tree, D>

NodeMatch is an immutable view to Node

fn from(node_match: NodeMatch<'tree, D>) -> Self

Converts to this type from the input type.

impl<D: Doc> Replacer<D> for Node<'_, D>

fn generate_replacement(&self, _nm: &NodeMatch<'_, D>) -> Underlying<D>

fn get_replaced_range( &self, nm: &NodeMatch<'_, D>, matcher: impl Matcher, ) -> Range<usize>