Struct ParseTreeMatch 

pub struct ParseTreeMatch<'subject> { /* private fields */ }

The result of matching a subject tree against a ParseTreePattern.

Holds the label bindings discovered during the match and, on failure, the first subject node that did not match. Borrows the subject tree.

Implementations

impl<'subject> ParseTreeMatch<'subject>

pub const fn succeeded(&self) -> bool

Returns whether the match succeeded (no node mismatched).

pub const fn tree(&self) -> Node<'subject>

The subject tree this match was computed against.

pub const fn mismatched_node(&self) -> Option<Node<'subject>>

The first subject node that failed to match, or None on success.

pub fn get(&self, label: &str) -> Option<Node<'subject>>

The last node bound to label, or None if nothing matched it.

Unlabeled tags <ID>/<expr> are filed under their rule/token name, so get("expr") returns a node matched by <expr>.

pub fn get_all(&self, label: &str) -> &[Node<'subject>]

Every node bound to label, in match order.

pub const fn labels(&self) -> &BTreeMap<String, Vec<Node<'subject>>>

All label bindings, keyed by label name.

Trait Implementations

impl<'subject> Clone for ParseTreeMatch<'subject>

fn clone(&self) -> ParseTreeMatch<'subject>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'subject> Debug for ParseTreeMatch<'subject>

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

Formats the value using the given formatter.