Struct combine::stream::CompleteStream

#[repr(transparent)]pub struct CompleteStream<S>(pub S);

Stream type which indicates that the stream is complete if end of input is reached

For most streams this is already the default but this wrapper can be used to override a nested PartialStream

Trait Implementations

impl<S: Clone> Clone for CompleteStream<S>

pub fn clone(&self) -> CompleteStream<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Copy> Copy for CompleteStream<S>

impl<S: Debug> Debug for CompleteStream<S>

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

Formats the value using the given formatter.

impl<S: Eq> Eq for CompleteStream<S>

impl<'s, S> From<&'s mut S> for &'s mut CompleteStream<S>

pub fn from(t: &'s mut S) -> Self

Performs the conversion.

impl<S> From<S> for CompleteStream<S>

pub fn from(t: S) -> Self

Performs the conversion.

impl<S: Ord> Ord for CompleteStream<S>

pub fn cmp(&self, other: &CompleteStream<S>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<S: PartialEq> PartialEq<CompleteStream<S>> for CompleteStream<S>

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

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

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

This method tests for !=.

impl<S: PartialOrd> PartialOrd<CompleteStream<S>> for CompleteStream<S>

pub fn partial_cmp(&self, other: &CompleteStream<S>) -> Option<Ordering>

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

pub fn lt(&self, other: &CompleteStream<S>) -> bool

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

pub fn le(&self, other: &CompleteStream<S>) -> bool

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

pub fn gt(&self, other: &CompleteStream<S>) -> bool

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

pub fn ge(&self, other: &CompleteStream<S>) -> bool

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

impl<S> Positioned for CompleteStream<S> where
    S: Positioned, 

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

Returns the current position of the stream.

impl<S> RangeStreamOnce for CompleteStream<S> where
    S: RangeStreamOnce, 

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> ResetStream for CompleteStream<S> where
    S: ResetStream, 

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<(), S::Error>

Attempts to reset the stream to an earlier position.

impl<S> StreamOnce for CompleteStream<S> 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

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

pub fn is_partial(&self) -> bool

Returns true if this stream only contains partial input.

impl<S> StructuralEq for CompleteStream<S>

impl<S> StructuralPartialEq for CompleteStream<S>