Struct ordered_stream::Peekable

pub struct Peekable<S: OrderedStream> { /* private fields */ }

A stream for the peekable function.

Implementations

impl<S: OrderedStream> Peekable<S>

pub fn into_inner(self) -> (S, Option<(S::Data, S::Ordering)>)

Convert into the source stream.

This method returns the source stream along with any buffered item and its ordering.

pub fn poll_peek_before( self: Pin<&mut Self>, cx: &mut Context<'_>, before: Option<&S::Ordering> ) -> Poll<PollResult<&S::Ordering, &mut S::Data>>

Peek on the next item in the stream

Trait Implementations

impl<S: Debug + OrderedStream> Debug for Peekable<S>where S::Ordering: Debug, S::Data: Debug,

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

Formats the value using the given formatter.

impl<S: OrderedStream> FusedOrderedStream for Peekable<S>

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<S: OrderedStream> OrderedStream for Peekable<S>

type Ordering = <S as OrderedStream>::Ordering

The type ordered by this stream.

type Data = <S as OrderedStream>::Data

The unordered data carried by this stream

fn poll_next_before( self: Pin<&mut Self>, cx: &mut Context<'_>, before: Option<&S::Ordering> ) -> Poll<PollResult<S::Ordering, S::Data>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if needed, and returning NoneBefore if it is known that the stream will not produce any more values ordered before the given point.

fn position_hint(&self) -> Option<MaybeBorrowed<'_, Self::Ordering>>

The minimum value of the ordering for any future items.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'__pin, S: OrderedStream> Unpin for Peekable<S>where __Origin<'__pin, S>: Unpin,