Struct KindMatcher

pub struct KindMatcher<L: Language> { /* private fields */ }

Implementations

impl<L: Language> KindMatcher<L>

pub fn new(node_kind: &str, lang: L) -> Self

pub fn try_new(node_kind: &str, lang: L) -> Result<Self, KindMatcherError>

pub fn from_id(kind: u16) -> Self

pub fn is_invalid(&self) -> bool

Whether the kind matcher contains undefined tree-sitter kind.

pub fn is_error_matcher(&self) -> bool

Whether the kind will match parsing error occurred in the source code. for example, we can use kind: ERROR in YAML to find invalid syntax in source. the name is_error implies the matcher itself is error. But here the matcher itself is valid and it is what it matches is error.

pub fn error_matcher() -> Self

Construct a matcher that only matches ERROR

Trait Implementations

impl<L: Clone + Language> Clone for KindMatcher<L>

fn clone(&self) -> KindMatcher<L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: Language> Matcher<L> for KindMatcher<L>

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.

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.

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