Struct blocking_permit::YieldStream

pub struct YieldStream<St, I> where
    St: Stream<Item = I>,  { /* fields omitted */ }

A Stream adapter that yields after every Poll::Ready(Some(_)) result from its source.

The wrapper may be useful to ensure that a Future that polls a Stream (directly or indirectly) yields (return Poll::Pending) between items. If the source stream already returns Poll::Pending then this will not add further Poll::Pending returns.

The type is enabled via the yield-stream feature.

Implementations

impl<St, I> YieldStream<St, I> where
    St: Stream<Item = I>, 

pub fn new(source: St) -> Self

Construct with source to wrap.

Trait Implementations

impl<St: Debug, I: Debug> Debug for YieldStream<St, I> where
    St: Stream<Item = I>, 

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

Formats the value using the given formatter.

impl<St, I> Stream for YieldStream<St, I> where
    St: Stream<Item = I>, 

type Item = I

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

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

Returns the bounds on the remaining length of the stream.