Struct LocalAsyncIter

pub struct LocalAsyncIter<'a, T>(/* private fields */);

Non-Send stream implemented using async functions.

This type does not implement Send.

Implementations

impl<'a, T: 'a> LocalAsyncIter<'a, T>

pub fn new<Fut: Future<Output = ()> + 'a>( f: impl FnOnce(LocalAsyncIterContext<T>) -> Fut, ) -> Self

Create a stream from an asynchronous function.

Example

use yield_return::LocalAsyncIter;
let iter = LocalAsyncIter::new(|mut y| async move {
    y.ret(1).await;
    y.ret(2).await;
});
let list: Vec<_> = futures::StreamExt::collect(iter).await;
assert_eq!(list, vec![1, 2]);

Trait Implementations

impl<T> FusedStream for LocalAsyncIter<'_, T>

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<T> Stream for LocalAsyncIter<'_, T>

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.