Struct combine::stream::state::State
[−]
[src]
pub struct State<I, X> { pub input: I, pub positioner: X, }
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
Methods
impl<I, X> State<I, X> where
I: StreamOnce,
X: Positioner<I::Item>,
[src]
I: StreamOnce,
X: Positioner<I::Item>,
pub fn with_positioner(input: I, positioner: X) -> State<I, X>
[src]
Creates a new State<I, X>
from an input stream and a positioner.
impl<I> State<I, I::Positioner> where
I: StreamOnce + DefaultPositioned,
I::Positioner: Positioner<I::Item>,
[src]
I: StreamOnce + DefaultPositioned,
I::Positioner: Positioner<I::Item>,
pub fn new(input: I) -> State<I, I::Positioner>
[src]
Creates a new State<I, X>
from an input stream and its default positioner.
Trait Implementations
impl<I: Clone, X: Clone> Clone for State<I, X>
[src]
fn clone(&self) -> State<I, X>
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<I: Debug, X: Debug> Debug for State<I, X>
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<I: PartialEq, X: PartialEq> PartialEq for State<I, X>
[src]
fn eq(&self, __arg_0: &State<I, X>) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &State<I, X>) -> bool
[src]
This method tests for !=
.
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>,
I::Error: ParseError<I::Item, I::Range, I::Position, StreamError = E>,
[src]
I: StreamOnce,
X: Positioner<I::Item>,
E: StreamError<I::Item, I::Range>,
I::Error: ParseError<I::Item, I::Range, X::Position, StreamError = E>,
I::Error: ParseError<I::Item, I::Range, I::Position, StreamError = E>,
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>,
I::Error: ParseError<I::Item, I::Range, I::Position, StreamError = S>,
[src]
I: StreamOnce,
X: Positioner<I::Item>,
S: StreamError<I::Item, I::Range>,
I::Error: ParseError<I::Item, I::Range, X::Position, StreamError = S>,
I::Error: ParseError<I::Item, I::Range, I::Position, StreamError = S>,
type Item = I::Item
The type of items which is yielded from this stream.
type Range = I::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. Read more
type Position = X::Position
Type which represents the position in a stream. Ord
is required to allow parsers to determine which of two positions are further ahead. Read more
type Error = I::Error
fn uncons(&mut self) -> Result<I::Item, StreamErrorFor<Self>>
[src]
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. Read more
fn is_partial(&self) -> bool
[src]
Returns true
if this stream only contains partial input. Read more
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>,
I::Error: ParseError<I::Item, I::Range, I::Position, StreamError = S>,
I::Position: Clone + Ord,
[src]
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>,
I::Error: ParseError<I::Item, I::Range, I::Position, StreamError = S>,
I::Position: Clone + Ord,
fn uncons_range(
&mut self,
size: usize
) -> Result<I::Range, StreamErrorFor<Self>>
[src]
&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
. Read more
fn uncons_while<F>(
&mut self,
predicate: F
) -> Result<I::Range, StreamErrorFor<Self>> where
F: FnMut(I::Item) -> bool,
[src]
&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
. Read more
fn distance(&self, end: &Self::Checkpoint) -> usize
[src]
Returns the distance between self
and end
. The returned usize
must be so that Read more
impl<I, X> Resetable for State<I, X> where
I: Resetable,
X: Resetable,
[src]
I: Resetable,
X: Resetable,
type Checkpoint = State<I::Checkpoint, X::Checkpoint>
fn checkpoint(&self) -> Self::Checkpoint
[src]
fn reset(&mut self, checkpoint: Self::Checkpoint)
[src]
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>,
I::Error: ParseError<I::Item, I::Range, I::Position, StreamError = E>,
X: Resetable + RangePositioner<I::Item, I::Range>,
[src]
I: FullRangeStream + Resetable,
I::Position: Clone + Ord,
E: StreamError<I::Item, I::Range>,
I::Error: ParseError<I::Item, I::Range, X::Position, StreamError = E>,
I::Error: ParseError<I::Item, I::Range, I::Position, StreamError = E>,
X: Resetable + RangePositioner<I::Item, I::Range>,