Struct AsyncStream

pub struct AsyncStream<T, G> { /* private fields */ }

Asynchronous stream of items

Implementations

impl<T, G> AsyncStream<T, G>

pub fn new<F>(f: F) -> Self

where F: FnOnce(Yielder<T>) -> G,

Constructs an AsyncStream by a factory function which returns a future.

Trait Implementations

impl<T: Debug, G: Debug> Debug for AsyncStream<T, G>

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

Formats the value using the given formatter.

impl<T, G> FusedStream for AsyncStream<T, G>

where G: Future<Output = ()>,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<T, G> Stream for AsyncStream<T, G>

where G: Future<Output = ()>,

type Item = T

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.