Struct combine::stream::span::Stream

pub struct Stream<S, E>(pub S, _);

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

impl<S, E> From<S> for Stream<S, E>

pub fn from(stream: S) -> Self

Performs the conversion.

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

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

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

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

This method tests for !=.

impl<S, E> Positioned for Stream<S, E> where
    S: StreamOnce + Positioned,
    S::Token: PartialEq,
    S::Range: PartialEq,
    E: ParseError<S::Token, S::Range, Span<S::Position>>,
    S::Error: ParseErrorInto<S::Token, S::Range, S::Position>,
    <S::Error as ParseError<S::Token, S::Range, S::Position>>::StreamError: StreamErrorInto<S::Token, S::Range>, 

pub fn position(&self) -> Span<S::Position>

Returns the current position of the stream.

impl<S, E> RangeStreamOnce for Stream<S, E> where
    S: RangeStream,
    S::Token: PartialEq,
    S::Range: PartialEq,
    E: ParseError<S::Token, S::Range, Span<S::Position>>,
    S::Error: ParseErrorInto<S::Token, S::Range, S::Position>,
    <S::Error as ParseError<S::Token, S::Range, S::Position>>::StreamError: StreamErrorInto<S::Token, S::Range>, 

pub 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.

pub 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.

pub 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.

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

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

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

Returns the entire range of self

impl<S, E> ResetStream for Stream<S, E> where
    S: ResetStream + Positioned,
    S::Token: PartialEq,
    S::Range: PartialEq,
    E: ParseError<S::Token, S::Range, Span<S::Position>>,
    S::Error: ParseErrorInto<S::Token, S::Range, S::Position>,
    <S::Error as ParseError<S::Token, S::Range, S::Position>>::StreamError: StreamErrorInto<S::Token, S::Range>, 

type Checkpoint = S::Checkpoint

pub 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

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

Attempts to reset the stream to an earlier position.

impl<S, E> StreamOnce for Stream<S, E> where
    S: StreamOnce + Positioned,
    S::Token: PartialEq,
    S::Range: PartialEq,
    E: ParseError<S::Token, S::Range, Span<S::Position>>,
    S::Error: ParseErrorInto<S::Token, S::Range, S::Position>,
    <S::Error as ParseError<S::Token, S::Range, S::Position>>::StreamError: StreamErrorInto<S::Token, S::Range>, 

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 = Span<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 = E

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

pub fn is_partial(&self) -> bool

Returns true if this stream only contains partial input.

impl<S, E> StructuralEq for Stream<S, E>

impl<S, E> StructuralPartialEq for Stream<S, E>