Enum ast_grep_core::matcher::Pattern

pub enum Pattern<L: Language> {
    MetaVar {
        meta_var: MetaVariable,
        kind: Option<u16>,
    },
    Terminal {
        text: String,
        is_named: bool,
        kind_id: u16,
    },
    Internal {
        kind_id: u16,
        children: Vec<Pattern<L>>,
        lang: PhantomData<L>,
    },
}

Variants

MetaVar

Fields

meta_var: MetaVariable

kind: Option<u16>

Terminal

Node without children.

Fields

text: String

is_named: bool

kind_id: u16

Internal

Non-Terminal Syntax Nodes are called Internal

Fields

kind_id: u16

children: Vec<Pattern<L>>

lang: PhantomData<L>

Implementations

impl<L: Language> Pattern<L>

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

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

pub fn has_error(&self) -> bool

pub fn is_trivial(&self) -> bool

pub fn defined_vars(&self) -> HashSet<&str>

Get all defined variables in the pattern. Used for validating rules and report undefined variables.

impl<L: Language> Pattern<L>

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

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

pub fn contextual( context: &str, selector: &str, lang: L ) -> Result<Self, PatternError>

pub fn doc(doc: StrDoc<L>) -> Self

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: Language> Debug for Pattern<L>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl<L: Language> Matcher<L> for Pattern<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>>