Struct pahs::ParseDriver

pub struct ParseDriver<S = ()> {
    pub state: S,
}

Maintains (optional) parsing state/context and serves as an easy entry point for some of the combinators.

Fields

state: S

The parser state

Implementations

impl ParseDriver<()>

pub fn new() -> Self

Creates a new ParseDriver without state.

impl<S> ParseDriver<S>

pub fn with_state(state: S) -> Self

Creates a new ParseDriver with state as initial state.

pub fn optional<P, T, E, F>(
    &mut self,
    pos: P,
    parser: F
) -> Progress<P, Option<T>, E> where
    P: Pos,
    E: Recoverable,
    F: FnOnce(&mut ParseDriver<S>, P) -> Progress<P, T, E>, 

Wraps the specified parser, making it optional.

If parser was successful, the value is mapped to Some(value). Recoverable failures are mapped to successes, with None as value. Irrecoverable failures stay that way.

pub fn alternate<P, T, E>(
    &mut self,
    pos: P
) -> Alternate<'_, P, T, E, S, LastErrorOnly<E>> where
    P: Pos,
    E: Recoverable, 

Tries all parsers supplied via one, in order, until one matches.

If none of the parsers were successful, returns the error of the last run parser. If you want to retrieve the errors of the other parsers as well, see alternate_accumulate_errors.

See Alternate.

pub fn alternate_accumulate_errors<P, T, E, A>(
    &mut self,
    pos: P,
    error_accumulator: A
) -> Alternate<'_, P, T, E, S, A> where
    P: Pos,
    E: Recoverable,
    A: ErrorAccumulator<P, E>, 

Tries all parsers supplied via one, in order, until one matches, accumulating errors of all failed parsers.

If none of the parsers were successful, returns the error accumulated by the error_accumulator.

See Alternate.

Trait Implementations

impl<S: Debug> Debug for ParseDriver<S>

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

Formats the value using the given formatter.

impl Default for ParseDriver<()>

pub fn default() -> Self

Returns the "default value" for a type.