Struct 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

Tuple Fields

0: S

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

fn from(t: S) -> Self

Converts to this type from the input type.

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

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

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

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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,

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

Returns the current position of the stream.

impl<S> RangeStreamOnce for CompleteStream<S>

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

where S: ResetStream,

type Checkpoint = <S as ResetStream>::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<(), S::Error>

Attempts to reset the stream to an earlier position.

impl<S> StreamOnce for CompleteStream<S>

where S: StreamOnce,

type Token = <S as StreamOnce>::Token

The type of items which is yielded from this stream.

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

type Position = <S as StreamOnce>::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 as StreamOnce>::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: Copy> Copy for CompleteStream<S>

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

impl<S> StructuralPartialEq for CompleteStream<S>