Struct generator_extensions::Fuse

pub struct Fuse<'a, R, G: Generator<R>> { /* fields omitted */ }

The return type of Resumable::fuse.

Implementations

impl<'a, R, G: Generator<R, Return = ()>> Fuse<'a, R, G>

#[must_use]pub fn new(pin: Pin<&'a mut G>) -> Self

Creates a new Fuse generator from a pinned generator.

Consider using Resumable::fuse instead.

#[must_use]pub fn is_complete(&self) -> bool

Returns true if the pinned generator has completed.

Notes

This method may return false even if the generator is complete if new was called with a generator which was already complete.

pub fn stop(&mut self)

Forces the Fuse to repeatedly return GeneratorState::Complete(()), even if the underlying pinned generator is not yet complete.

The underlying pinned generator is neither made to complete nor dropped.

#[must_use]pub fn into_inner(self) -> Pin<&'a mut G>

Retrieves the original pinned generator.

Trait Implementations

impl<'a, R, G: Generator<R, Return = ()>> Debug for Fuse<'a, R, G>

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

Formats the value using the given formatter.

impl<'a, R, G: Generator<R, Return = ()>> Generator<R> for Fuse<'a, R, G>

type Yield = G::Yield

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

The type of value this generator yields.

type Return = ()

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

The type of value this generator returns.

pub fn resume(
    self: Pin<&mut Self>,
    arg: R
) -> GeneratorState<Self::Yield, Self::Return>

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

Resumes the execution of this generator.