[−][src]Module combine::stream
Streams are similar to the Iterator
trait in that they represent some sequential set of items
which can be retrieved one by one. Where Stream
s differ is that they are allowed to return
errors instead of just None
and if they implement the RangeStreamOnce
trait they are also
capable of returning multiple items at the same time, usually in the form of a slice.
In addition to he functionality above, a proper Stream
usable by a Parser
must also have a
position (marked by the Positioned
trait) and must also be resetable (marked by the
ResetStream
trait). The former is used to ensure that errors at different points in the stream
aren't combined and the latter is used in parsers such as or
to try multiple alternative
parses.
Re-exports
pub use self::decoder::Decoder; |
Modules
buffered | Stream wrapper which provides a |
decoder | |
easy | Stream wrapper which provides an informative and easy to use error type. |
position | Stream wrapper which provides more detailed position information. |
read | Stream wrapper allowing |
state | Stream wrapper allowing custom state to be used. |
Structs
CompleteStream | Stream type which indicates that the stream is complete if end of input is reached |
IteratorStream | Wrapper around iterators which allows them to be treated as a stream.
Returned by |
MaybePartialStream | |
PartialStream | Stream type which indicates that the stream is partial if end of input is reached |
PointerOffset | Newtype around a pointer offset into a slice stream ( |
SliceStream | Newtype for constructing a stream from a slice where the items in the slice are not copyable. |
Traits
Positioned | A type which has a position. |
Range | Trait representing a range of elements. |
RangeStream | A |
RangeStreamOnce | A |
ResetStream | A |
Stream | A stream of tokens which can be duplicated |
StreamOnce |
|
Functions
decode | Decodes |
uncons | |
uncons_range | |
uncons_while | Removes items from the input while |
uncons_while1 | Takes items from stream, testing each one with |
Type Definitions
StreamErrorFor | Convenience alias over the |