Struct async_utils::stream::StreamWithEpitaph

pub struct StreamWithEpitaph<S, E> { /* private fields */ }

A Stream that returns the values of the wrapped stream until the wrapped stream is exhausted. Then it returns a single epitaph value before being exhausted

Implementations

impl<S, E> StreamWithEpitaph<S, E>

pub fn inner(&self) -> &S

Provide immutable access to the inner stream. This is safe as if the stream were being polled, we would not be able to access a reference to self to pass to this method.

pub fn inner_mut(&mut self) -> &mut S

Provide mutable access to the inner stream. This is safe as if the stream were being polled, we would not be able to access a mutable reference to self to pass to this method.

Trait Implementations

impl<S, T, E> FusedStream for StreamWithEpitaph<S, E>where S: Stream<Item = T> + FusedStream + Unpin, E: Unpin, T: Unpin,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<S, T, E> Stream for StreamWithEpitaph<S, E>where S: Stream<Item = T> + Unpin, E: Unpin, T: Unpin,

type Item = StreamItem<T, E>

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.