Struct NodeMatch 

pub struct NodeMatch<'t, D: Doc>(/* private fields */);

Result of a successful pattern match containing the matched node and captured variables.

NodeMatch combines an AST node with the meta-variables captured during pattern matching. It acts like a regular Node (through [Deref]) while also providing access to captured variables through [get_env].

Lifetime

The lifetime 't ties the match to its source document, ensuring memory safety.

Usage Patterns

// Use as a regular node
let text = node_match.text();
let position = node_match.start_pos();

// Access captured meta-variables
let env = node_match.get_env();
let captured_name = env.get_match("VAR_NAME").unwrap();

// Generate replacement code
let edit = node_match.replace_by("new code with $VAR_NAME");

Type Parameters

• 't - Lifetime tied to the source document
• D: Doc - Document type containing the source and language info

Implementations

impl<'tree, D: Doc> NodeMatch<'tree, D>

pub const fn new(node: Node<'tree, D>, env: MetaVarEnv<'tree, D>) -> Self

pub const fn get_node(&self) -> &Node<'tree, D>

pub const fn get_env(&self) -> &MetaVarEnv<'tree, D>

Returns the populated MetaVarEnv for this match.

pub const fn get_env_mut(&mut self) -> &mut MetaVarEnv<'tree, D>

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

pub fn replace_by<R: Replacer<D>>( &self, replacer: R, ) -> Edit<<D as Doc>::Source>

Methods from Deref<Target = Node<'tree, D>>

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>

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

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<Self>

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

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<'t, D: Clone + Doc> Clone for NodeMatch<'t, D>

fn clone(&self) -> NodeMatch<'t, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'t, D: Debug + Doc> Debug for NodeMatch<'t, D>

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

Formats the value using the given formatter.

impl<'tree, D: Doc> Deref for NodeMatch<'tree, D>

NodeMatch is an immutable view to Node

type Target = Node<'tree, D>

The resulting type after dereferencing.

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

Dereferences the value.

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.