pub struct Stream<Input, X> {
pub input: Input,
pub positioner: X,
}
Expand description
The Stream<Input>
struct maintains the current position in the stream Input
using
the Positioner
trait to track the position.
let result = token(b'9')
.message("Not a nine")
.easy_parse(position::Stream::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: Input
The input stream used when items are requested
positioner: X
The positioner used to update the current position
Implementations
sourceimpl<Input, X> Stream<Input, X> where
Input: StreamOnce,
X: Positioner<Input::Token>,
impl<Input, X> Stream<Input, X> where
Input: StreamOnce,
X: Positioner<Input::Token>,
sourcepub fn with_positioner(input: Input, positioner: X) -> Stream<Input, X>
pub fn with_positioner(input: Input, positioner: X) -> Stream<Input, X>
Creates a new Stream<Input, X>
from an input stream and a positioner.
sourceimpl<Input> Stream<Input, Input::Positioner> where
Input: StreamOnce + DefaultPositioned,
Input::Positioner: Positioner<Input::Token>,
impl<Input> Stream<Input, Input::Positioner> where
Input: StreamOnce + DefaultPositioned,
Input::Positioner: Positioner<Input::Token>,
sourcepub fn new(input: Input) -> Stream<Input, Input::Positioner>
pub fn new(input: Input) -> Stream<Input, Input::Positioner>
Creates a new Stream<Input, X>
from an input stream and its default positioner.
Trait Implementations
sourceimpl<Input, X, E> Positioned for Stream<Input, X> where
Input: StreamOnce,
X: Positioner<Input::Token>,
E: StreamError<Input::Token, Input::Range>,
Input::Error: ParseError<Input::Token, Input::Range, X::Position, StreamError = E>,
Input::Error: ParseError<Input::Token, Input::Range, Input::Position, StreamError = E>,
impl<Input, X, E> Positioned for Stream<Input, X> where
Input: StreamOnce,
X: Positioner<Input::Token>,
E: StreamError<Input::Token, Input::Range>,
Input::Error: ParseError<Input::Token, Input::Range, X::Position, StreamError = E>,
Input::Error: ParseError<Input::Token, Input::Range, Input::Position, StreamError = E>,
sourceimpl<Input, X, S> RangeStreamOnce for Stream<Input, X> where
Input: RangeStreamOnce,
X: RangePositioner<Input::Token, Input::Range>,
S: StreamError<Input::Token, Input::Range>,
Input::Error: ParseError<Input::Token, Input::Range, X::Position, StreamError = S>,
Input::Error: ParseError<Input::Token, Input::Range, Input::Position, StreamError = S>,
Input::Position: Clone + Ord,
impl<Input, X, S> RangeStreamOnce for Stream<Input, X> where
Input: RangeStreamOnce,
X: RangePositioner<Input::Token, Input::Range>,
S: StreamError<Input::Token, Input::Range>,
Input::Error: ParseError<Input::Token, Input::Range, X::Position, StreamError = S>,
Input::Error: ParseError<Input::Token, Input::Range, Input::Position, StreamError = S>,
Input::Position: Clone + Ord,
sourcefn uncons_range(
&mut self,
size: usize
) -> Result<Input::Range, StreamErrorFor<Self>>
fn uncons_range(
&mut self,
size: usize
) -> Result<Input::Range, StreamErrorFor<Self>>
Takes size
elements from the stream.
Fails if the length of the stream is less than size
. Read more
sourcefn uncons_while<F>(
&mut self,
predicate: F
) -> Result<Input::Range, StreamErrorFor<Self>> where
F: FnMut(Input::Token) -> bool,
fn uncons_while<F>(
&mut self,
predicate: F
) -> Result<Input::Range, StreamErrorFor<Self>> where
F: FnMut(Input::Token) -> bool,
Takes items from stream, testing each one with predicate
.
returns the range of items which passed predicate
. Read more
sourcefn uncons_while1<F>(
&mut self,
predicate: F
) -> ParseResult<Self::Range, StreamErrorFor<Self>> where
F: FnMut(Self::Token) -> bool,
fn uncons_while1<F>(
&mut self,
predicate: F
) -> ParseResult<Self::Range, StreamErrorFor<Self>> where
F: FnMut(Self::Token) -> bool,
Takes items from stream, testing each one with predicate
returns a range of at least one items which passed predicate
. Read more
sourcefn distance(&self, end: &Self::Checkpoint) -> usize
fn distance(&self, end: &Self::Checkpoint) -> usize
Returns the distance between self
and end
. The returned usize
must be so that Read more
sourceimpl<Input, X, S> ResetStream for Stream<Input, X> where
Input: ResetStream,
X: Positioner<Input::Token>,
S: StreamError<Input::Token, Input::Range>,
Input::Error: ParseError<Input::Token, Input::Range, X::Position, StreamError = S>,
Input::Error: ParseError<Input::Token, Input::Range, Input::Position, StreamError = S>,
impl<Input, X, S> ResetStream for Stream<Input, X> where
Input: ResetStream,
X: Positioner<Input::Token>,
S: StreamError<Input::Token, Input::Range>,
Input::Error: ParseError<Input::Token, Input::Range, X::Position, StreamError = S>,
Input::Error: ParseError<Input::Token, Input::Range, Input::Position, StreamError = S>,
type Checkpoint = Stream<<Input as ResetStream>::Checkpoint, <X as Positioner<<Input as StreamOnce>::Token>>::Checkpoint>
sourcefn checkpoint(&self) -> Self::Checkpoint
fn checkpoint(&self) -> Self::Checkpoint
Creates a Checkpoint
at the current position which can be used to reset the stream
later to the current position Read more
sourceimpl<Input, X, S> StreamOnce for Stream<Input, X> where
Input: StreamOnce,
X: Positioner<Input::Token>,
S: StreamError<Input::Token, Input::Range>,
Input::Error: ParseError<Input::Token, Input::Range, X::Position, StreamError = S> + ParseError<Input::Token, Input::Range, Input::Position, StreamError = S>,
impl<Input, X, S> StreamOnce for Stream<Input, X> where
Input: StreamOnce,
X: Positioner<Input::Token>,
S: StreamError<Input::Token, Input::Range>,
Input::Error: ParseError<Input::Token, Input::Range, X::Position, StreamError = S> + ParseError<Input::Token, Input::Range, Input::Position, StreamError = S>,
type Token = <Input as StreamOnce>::Token
type Token = <Input as StreamOnce>::Token
The type of items which is yielded from this stream.
type Range = <Input as StreamOnce>::Range
type Range = <Input 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::Token
for this type. Read more
type Position = <X as Positioner<<Input as StreamOnce>::Token>>::Position
type Position = <X as Positioner<<Input as StreamOnce>::Token>>::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 = <Input as StreamOnce>::Error
sourcefn uncons(&mut self) -> Result<Input::Token, StreamErrorFor<Self>>
fn uncons(&mut self) -> Result<Input::Token, StreamErrorFor<Self>>
Takes a stream and removes its first token, yielding the token and the rest of the elements.
Returns Err
if no element could be retrieved. Read more
sourcefn is_partial(&self) -> bool
fn is_partial(&self) -> bool
Returns true
if this stream only contains partial input. Read more
impl<Input, X> StructuralPartialEq for Stream<Input, X>
Auto Trait Implementations
impl<Input, X> RefUnwindSafe for Stream<Input, X> where
Input: RefUnwindSafe,
X: RefUnwindSafe,
impl<Input, X> Send for Stream<Input, X> where
Input: Send,
X: Send,
impl<Input, X> Sync for Stream<Input, X> where
Input: Sync,
X: Sync,
impl<Input, X> Unpin for Stream<Input, X> where
Input: Unpin,
X: Unpin,
impl<Input, X> UnwindSafe for Stream<Input, X> where
Input: UnwindSafe,
X: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more