Struct combine::stream::state::Stream

pub struct Stream<S, U> {
    pub stream: S,
    pub state: U,
}

Fields

stream: S

state: U

Trait Implementations

impl<S, U> Positioned for Stream<S, U> where
    S: Positioned, 

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

Returns the current position of the stream.

impl<S, U> StreamOnce for Stream<S, U> where
    S: StreamOnce, 

type Token = S::Token

The type of items which is yielded from this stream.

type Range = S::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.

type Position = S::Position

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

type Error = S::Error

fn uncons(&mut self) -> Result<S::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.

fn is_partial(&self) -> bool

Returns true if this stream only contains partial input.

impl<S, U> ResetStream for Stream<S, U> where
    S: ResetStream, 

type Checkpoint = S::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

fn reset(&mut self, checkpoint: Self::Checkpoint) -> Result<(), Self::Error>

Attempts to reset the stream to an earlier position.

impl<S, U> RangeStreamOnce for Stream<S, U> where
    S: RangeStreamOnce, 

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

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

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

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

fn uncons_while1<F>(
    &mut self,
    f: 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.

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

Returns the distance between self and end. The returned usize must be so that

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

Returns the entire range of self

impl<S: Clone, U: Clone> Clone for Stream<S, U>

fn clone(&self) -> Stream<S, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Copy, U: Copy> Copy for Stream<S, U>

impl<S: Eq, U: Eq> Eq for Stream<S, U>

impl<S: Ord, U: Ord> Ord for Stream<S, U>

fn cmp(&self, other: &Stream<S, U>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<S: PartialEq, U: PartialEq> PartialEq<Stream<S, U>> for Stream<S, U>

fn eq(&self, other: &Stream<S, U>) -> bool

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

fn ne(&self, other: &Stream<S, U>) -> bool

This method tests for !=.

impl<S: PartialOrd, U: PartialOrd> PartialOrd<Stream<S, U>> for Stream<S, U>

fn partial_cmp(&self, other: &Stream<S, U>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Stream<S, U>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Stream<S, U>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Stream<S, U>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Stream<S, U>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<S: Debug, U: Debug> Debug for Stream<S, U>

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

Formats the value using the given formatter.