Struct AsyncGen 

pub struct AsyncGen<Fut, Y> { /* private fields */ }

Represent an asyncronus generator. It implementations AsyncGenerator trait.

This struct is created by gen(). See its documentation for more details.

Implementations

impl<Fut, Y, R> AsyncGen<Fut, Y>

where Fut: Future<Output = Return<R>>,

pub fn poll_resume( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<GeneratorState<Y, R>>

See AsyncGenerator::poll_resume for more details.

pub async fn resume(self: &mut Pin<&mut Self>) -> GeneratorState<Y, R>

See AsyncGenerator::poll_resume for more details.

impl<Fut, Y> AsyncGen<Fut, Y>

where Fut: Future<Output = Return<()>>,

pub fn into_async_iter(self) -> AsyncIter<Self>

Creates an async iterator from this generator.

See AsyncIter for more details.

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

See futures_core::Stream::poll_next for more details.

Trait Implementations

impl<Fut, Y, R> AsyncGenerator for AsyncGen<Fut, Y>

where Fut: Future<Output = Return<R>>,

type Yield = Y

The type of value this generator yields.

type Return = R

The type of value this generator returns.

fn poll_resume( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<GeneratorState<Self::Yield, Self::Return>>

Resumes the execution of this generator.

impl<Fut, Y> Drop for AsyncGen<Fut, Y>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.