combine::stream::state

Struct State

Source
pub struct State<I, X> {
    pub input: I,
    pub positioner: X,
}
Expand description

The State<I> struct maintains the current position in the stream I using the Positioner trait to track the position.

    let result = token(b'9')
        .message("Not a nine")
        .easy_parse(State::new(&b"8"[..]));
    assert_eq!(result, Err(easy::Errors {
        position: 0,
        errors: vec![
            easy::Error::Unexpected(b'8'.into()),
            easy::Error::Expected(b'9'.into()),
            easy::Error::Message("Not a nine".into())
        ]
    }));

Fields§

§input: I

The input stream used when items are requested

§positioner: X

The positioner used to update the current position

Implementations§

Source§

impl<I, X> State<I, X>
where I: StreamOnce, X: Positioner<I::Item>,

Source

pub fn with_positioner(input: I, positioner: X) -> State<I, X>

Creates a new State<I, X> from an input stream and a positioner.

Source§

impl<I> State<I, I::Positioner>

Source

pub fn new(input: I) -> State<I, I::Positioner>

Creates a new State<I, X> from an input stream and its default positioner.

Trait Implementations§

Source§

impl<I: Clone, X: Clone> Clone for State<I, X>

Source§

fn clone(&self) -> State<I, X>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<I: Debug, X: Debug> Debug for State<I, X>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<I, X, E> FullRangeStream for State<I, X>
where I: FullRangeStream + Resetable, I::Position: Clone + Ord, E: StreamError<I::Item, I::Range>, I::Error: ParseError<I::Item, I::Range, X::Position, StreamError = E> + ParseError<I::Item, I::Range, I::Position, StreamError = E>, X: Resetable + RangePositioner<I::Item, I::Range>,

Source§

fn range(&self) -> Self::Range

Returns the entire range of self
Source§

impl<I: PartialEq, X: PartialEq> PartialEq for State<I, X>

Source§

fn eq(&self, other: &State<I, X>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<I, X, E> Positioned for State<I, X>
where I: StreamOnce, X: Positioner<I::Item>, E: StreamError<I::Item, I::Range>, I::Error: ParseError<I::Item, I::Range, X::Position, StreamError = E> + ParseError<I::Item, I::Range, I::Position, StreamError = E>,

Source§

fn position(&self) -> Self::Position

Returns the current position of the stream.
Source§

impl<I, X, S> RangeStreamOnce for State<I, X>
where I: RangeStreamOnce, X: Resetable + RangePositioner<I::Item, I::Range>, S: StreamError<I::Item, I::Range>, I::Error: ParseError<I::Item, I::Range, X::Position, StreamError = S> + ParseError<I::Item, I::Range, I::Position, StreamError = S>, I::Position: Clone + Ord,

Source§

fn uncons_range( &mut self, size: usize, ) -> Result<I::Range, StreamErrorFor<Self>>

Takes size elements from the stream. Fails if the length of the stream is less than size.
Source§

fn uncons_while<F>( &mut self, predicate: F, ) -> Result<I::Range, StreamErrorFor<Self>>
where F: FnMut(I::Item) -> bool,

Takes items from stream, testing each one with predicate. returns the range of items which passed predicate.
Source§

fn uncons_while1<F>( &mut self, predicate: F, ) -> FastResult<Self::Range, StreamErrorFor<Self>>
where F: FnMut(Self::Item) -> bool,

Takes items from stream, testing each one with predicate returns a range of at least one items which passed predicate. Read more
Source§

fn distance(&self, end: &Self::Checkpoint) -> usize

Returns the distance between self and end. The returned usize must be so that Read more
Source§

impl<I, X> Resetable for State<I, X>
where I: Resetable, X: Resetable,

Source§

type Checkpoint = State<<I as Resetable>::Checkpoint, <X as Resetable>::Checkpoint>

Source§

fn checkpoint(&self) -> Self::Checkpoint

Source§

fn reset(&mut self, checkpoint: Self::Checkpoint)

Source§

impl<I, X, S> StreamOnce for State<I, X>
where I: StreamOnce, X: Positioner<I::Item>, S: StreamError<I::Item, I::Range>, I::Error: ParseError<I::Item, I::Range, X::Position, StreamError = S> + ParseError<I::Item, I::Range, I::Position, StreamError = S>,

Source§

type Item = <I as StreamOnce>::Item

The type of items which is yielded from this stream.
Source§

type Range = <I as StreamOnce>::Range

The type of a range of items yielded from this stream. Types which do not a have a way of yielding ranges of items should just use the Self::Item for this type.
Source§

type Position = <X as Positioner<<I as StreamOnce>::Item>>::Position

Type which represents the position in a stream. Ord is required to allow parsers to determine which of two positions are further ahead.
Source§

type Error = <I as StreamOnce>::Error

Source§

fn uncons(&mut self) -> Result<I::Item, StreamErrorFor<Self>>

Takes a stream and removes its first item, yielding the item and the rest of the elements. Returns Err if no element could be retrieved.
Source§

fn is_partial(&self) -> bool

Returns true if this stream only contains partial input. Read more
Source§

impl<I, X> StructuralPartialEq for State<I, X>

Auto Trait Implementations§

§

impl<I, X> Freeze for State<I, X>
where I: Freeze, X: Freeze,

§

impl<I, X> RefUnwindSafe for State<I, X>

§

impl<I, X> Send for State<I, X>
where I: Send, X: Send,

§

impl<I, X> Sync for State<I, X>
where I: Sync, X: Sync,

§

impl<I, X> Unpin for State<I, X>
where I: Unpin, X: Unpin,

§

impl<I, X> UnwindSafe for State<I, X>
where I: UnwindSafe, X: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<I> RangeStream for I

Source§

impl<I> Stream for I