Trait ast_grep_core::matcher::Matcher
source · pub trait Matcher<L: Language> {
// Required method
fn match_node_with_env<'tree, D: Doc<Lang = L>>(
&self,
_node: Node<'tree, D>,
_env: &mut Cow<'_, MetaVarEnv<'tree, D>>
) -> Option<Node<'tree, D>>;
// Provided methods
fn potential_kinds(&self) -> Option<BitSet> { ... }
fn get_match_len<D: Doc<Lang = L>>(
&self,
_node: Node<'_, D>
) -> Option<usize> { ... }
fn match_node<'tree, D: Doc<Lang = L>>(
&self,
node: Node<'tree, D>
) -> Option<NodeMatch<'tree, D>> { ... }
fn find_node<'tree, D: Doc<Lang = L>>(
&self,
node: Node<'tree, D>
) -> Option<NodeMatch<'tree, D>> { ... }
}
Expand description
Matcher
defines whether a tree-sitter node matches certain pattern,
and update the matched meta-variable values in MetaVarEnv
.
N.B. At least one positive term is required for matching
Required Methods§
sourcefn match_node_with_env<'tree, D: Doc<Lang = L>>(
&self,
_node: Node<'tree, D>,
_env: &mut Cow<'_, MetaVarEnv<'tree, D>>
) -> Option<Node<'tree, D>>
fn match_node_with_env<'tree, D: Doc<Lang = L>>( &self, _node: Node<'tree, D>, _env: &mut Cow<'_, MetaVarEnv<'tree, D>> ) -> Option<Node<'tree, D>>
Returns the node why the input is matched or None if not matched.
The return value is usually input node itself, but it can be different node.
For example Has
matcher can return the child or descendant node.
Provided Methods§
sourcefn potential_kinds(&self) -> Option<BitSet>
fn potential_kinds(&self) -> Option<BitSet>
Returns a bitset for all possible target node kind ids. Returns None if the matcher needs to try against all node kind.
sourcefn get_match_len<D: Doc<Lang = L>>(&self, _node: Node<'_, D>) -> Option<usize>
fn get_match_len<D: Doc<Lang = L>>(&self, _node: Node<'_, D>) -> Option<usize>
get_match_len will skip trailing anonymous child node to exclude punctuation.
fn match_node<'tree, D: Doc<Lang = L>>( &self, node: Node<'tree, D> ) -> Option<NodeMatch<'tree, D>>
fn find_node<'tree, D: Doc<Lang = L>>( &self, node: Node<'tree, D> ) -> Option<NodeMatch<'tree, D>>
Object Safety§
This trait is not object safe.