Enum Rule 

pub enum Rule {
    Pattern(Pattern),
    Kind(KindMatcher),
    Regex(RegexMatcher),
    NthChild(NthChild),
    Range(RangeMatcher),
    Inside(Box<Inside>),
    Has(Box<Has>),
    Precedes(Box<Precedes>),
    Follows(Box<Follows>),
    All(All<Rule>),
    Any(Any<Rule>),
    Not(Box<Not<Rule>>),
    Matches(ReferentRule),
}

Variants

Pattern(Pattern)

Kind(KindMatcher)

Regex(RegexMatcher)

NthChild(NthChild)

Range(RangeMatcher)

Inside(Box<Inside>)

Has(Box<Has>)

Precedes(Box<Precedes>)

Follows(Box<Follows>)

All(All<Rule>)

Any(Any<Rule>)

Not(Box<Not<Rule>>)

Matches(ReferentRule)

Implementations

impl Rule

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

pub fn verify_util(&self) -> Result<(), RuleSerializeError>

check if util rules used are defined

Trait Implementations

impl Default for Rule

Rule matches nothing by default. In Math jargon, Rule is vacuously false.

fn default() -> Self

Returns the “default value” for a type.

impl Matcher for Rule

fn match_node_with_env<'tree, D: Doc>( &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>(&self, _node: Node<'_, D>) -> Option<usize>

where D: Doc,

get_match_len will skip trailing anonymous child node to exclude punctuation.