Struct PairsHelper

pub struct PairsHelper<'i, Rule: RuleType>(pub Pairs<'i, Rule>);

A useful wrapper around pest Pairs, that provide several convenient shortcuts to read the Pair’s inside it.

It is intended to be used in exhaustive parsing, and will assert that all Pair’s have been read out when this wrapper is dropped.

Tuple Fields

0: Pairs<'i, Rule>

Implementations

impl<'i, Rule: RuleType> PairsHelper<'i, Rule>

pub fn next(&mut self) -> Pair<'i, Rule>

Get next Pair. Panics if there is not one.

pub fn next_rule(&mut self, rule: Rule) -> Pair<'i, Rule>

Get next Pair and assert its rule type. Panics if there is not one, or the rule type does not match.

pub fn next_rule_opt(&mut self, rule: Rule) -> Option<Pair<'i, Rule>>

Get the next Pair if it matches the given Rule. This will not panic.

pub fn iter_while<'j>(&'j mut self, rule: Rule) -> PairPartialIter<'i, 'j, Rule>

Create an iterator of the first consecutive Pair’s that match a given Rule.

Trait Implementations

impl<'i, Rule: RuleType> Drop for PairsHelper<'i, Rule>

fn drop(&mut self)

An error message will be printed when this PairsHelper is dropped.

We handled the “double panic” issue by not asserting when the drop is already initiated by another panic.