Struct ast_grep_core::Node

pub struct Node<'r, L: Language> { /* private fields */ }

’r represents root lifetime

Implementations

impl<'r, L: Language> Node<'r, L>

APIs for Node inspection

pub fn is_leaf(&self) -> bool

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

pub fn kind_id(&self) -> u16

pub fn is_named(&self) -> bool

pub fn get_ts_node(&self) -> Node<'r>

the underlying tree-sitter Node

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

byte offsets of start and end.

pub fn start_pos(&self) -> (usize, usize)

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

pub fn end_pos(&self) -> (usize, usize)

Nodes’ end position in terms of rows and columns.

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

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

Node’s tree structure dumped in Lisp like S-experssion

pub fn lang(&self) -> &L

impl<'r, L: Language> Node<'r, L>

Corresponds to inside/has/precedes/follows

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

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

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

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

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

impl<'r, L: Language> Node<'r, L>

tree traversal API

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

pub fn dfs<'s>(&'s self) -> Pre<'r, L>

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

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

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

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

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

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

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

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

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

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

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

impl<'r, L: Language> Node<'r, L>

Tree manipulation API

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

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

pub fn after(&self) -> Edit

pub fn before(&self) -> Edit

pub fn append(&self) -> Edit

pub fn prepend(&self) -> Edit

pub fn empty(&self) -> Option<Edit>

Empty children. Remove all child node

pub fn remove(&self) -> Edit

Remove the node itself

Trait Implementations

impl<'tree, L: Language> Borrow<Node<'tree, L>> for NodeMatch<'tree, L>

NodeMatch is an immutable view to Node

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

Immutably borrows from an owned value.

impl<'r, L: Clone + Language> Clone for Node<'r, L>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tree, L: Language> From<Node<'tree, L>> for NodeMatch<'tree, L>

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

Converts to this type from the input type.

impl<'tree, L: Language> From<NodeMatch<'tree, L>> for Node<'tree, L>

NodeMatch is an immutable view to Node

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

Converts to this type from the input type.