Struct AsyncIter 

pub struct AsyncIter<G> { /* private fields */ }

An async iterator over the values yielded by an underlying generator.

Example

use async_gen::{gen, AsyncIter};
use futures::{StreamExt, Stream};

fn get_async_iter() -> impl Stream<Item = i32> {
    AsyncIter::from(gen! {
        yield 1;
        yield 2;
        yield 3;
    })
}

#[nio::main]
async fn main() {
    let it = get_async_iter();
    let v: Vec<_> = it.collect().await;
    assert_eq!(v, [1, 2, 3]);
}

Implementations

impl<G> AsyncIter<G>

where G: AsyncGenerator<Return = ()>,

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

See Stream::poll_next for more details.

Trait Implementations

impl<G: Clone> Clone for AsyncIter<G>

fn clone(&self) -> AsyncIter<G>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<G> From<G> for AsyncIter<G>

where G: AsyncGenerator<Return = ()>,

fn from(gen: G) -> Self

Converts to this type from the input type.

impl<G> Stream for AsyncIter<G>

where G: AsyncGenerator<Return = ()>,

type Item = <G as AsyncGenerator>::Yield

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.