Struct pahs::Progress

#[must_use]pub struct Progress<P, T, E> {
    pub pos: P,
    pub status: Result<T, E>,
}

Tracks the result of a parser: where it is and if it is successful.

On success, some value has been parsed. On failure, nothing has been parsed and the error indicates the reason for the failure. The returned point indicates where to next start parsing, often unchanged on failure.

Fields

pos: P

The current location.

status: Result<T, E>

If the point indicates the location of a successful or failed parse.

Implementations

impl<P, T, E> Progress<P, T, E>

pub fn success(pos: P, val: T) -> Progress<P, T, E>

Creates a new Progress value indicating a successful parse.

pub fn failure(pos: P, err: E) -> Progress<P, T, E>

Creates a new Progress value indicating a failed parse.

pub fn map<F, T2>(self, f: F) -> Progress<P, T2, E> where
    F: FnOnce(T) -> T2, 

Maps the success value, if there is one.

If the current position is needed while mapping, see map_with_pos instead.

pub fn map_with_pos<F, T2>(self, f: F) -> Progress<P, T2, E> where
    F: FnOnce(T, P) -> T2,
    P: Clone, 

Maps the success value, if there is one.

pub fn and_then<T2, F>(self, restore_to: P, f: F) -> Progress<P, T2, E> where
    F: FnOnce(T) -> Result<T2, E>, 

Maps the success value, if there is one, potentially converting into a failure.

If the current position is needed while mapping, see and_then_with_pos instead.

pub fn and_then_with_pos<T2, F>(self, restore_to: P, f: F) -> Progress<P, T2, E> where
    F: FnOnce(T, P) -> Result<T2, E>,
    P: Clone, 

Maps the success value, if there is one, potentially converting into a failure.

pub fn map_err<E2, F>(self, f: F) -> Progress<P, T, E2> where
    F: FnOnce(E) -> E2, 

Maps the failure value, if there is one.

If the current position is needed while mapping, see map_err_with_pos instead.

pub fn map_err_with_pos<E2, F>(self, f: F) -> Progress<P, T, E2> where
    F: FnOnce(E, P) -> E2,
    P: Clone, 

Maps the failure value, if there is one.

pub fn into_optional(self, reset_to: P) -> (P, Option<T>)

Returns the value and the current position on success, or resets the position and returns None on failure.

pub fn unwrap(self) -> (P, T)

Unwraps itself into the position and the successfully parsed value.

Panics if the parse status is an Err.

pub fn unwrap_err(self) -> (P, E)

Unwraps itself into the point and the error.

Panics if the parse status is not an Err.

pub fn finish(self) -> (P, Result<T, E>)

Converts this progress into a position and a result.

Trait Implementations

impl<P: Clone, T: Clone, E: Clone> Clone for Progress<P, T, E>

pub fn clone(&self) -> Progress<P, T, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Copy, T: Copy, E: Copy> Copy for Progress<P, T, E>

impl<P: Debug, T: Debug, E: Debug> Debug for Progress<P, T, E>

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

Formats the value using the given formatter.

impl<P: PartialEq, T: PartialEq, E: PartialEq> PartialEq<Progress<P, T, E>> for Progress<P, T, E>

pub fn eq(&self, other: &Progress<P, T, E>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Progress<P, T, E>) -> bool

This method tests for !=.

impl<P, T, E> StructuralPartialEq for Progress<P, T, E>