std::ops::Generator - Rust
Description: API documentation for the Rust `Generator` trait in crate `std`.
Keywords: rust, rustlang, rust-lang, Generator

# [−][src]Trait std::ops::Generator

    #[lang = "generator"]
    pub trait Generator<R = ()> {
        type Yield;
        type Return;
        fn resume(
            self: Pin<&mut Self>,
            arg: R
        ) -> GeneratorState<Self::Yield, Self::Return>;
    }

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

The trait implemented by builtin generator types.

Generators, also commonly referred to as coroutines, are currently an experimental language feature in Rust. Added in RFC 2033 generators are currently intended to primarily provide a building block for async/await syntax but will likely extend to also providing an ergonomic definition for iterators and other primitives.

The syntax and semantics for generators is unstable and will require a further RFC for stabilization. At this time, though, the syntax is closure-like:

    #![feature(generators, generator_trait)]

    use std::ops::{Generator, GeneratorState};
    use std::pin::Pin;

    fn main() {
        let mut generator = || {
            yield 1;
            return "foo"
        };

        match Pin::new(&mut generator).resume(()) {
            GeneratorState::Yielded(1) => {}
            _ => panic!("unexpected return from resume"),
        }
        match Pin::new(&mut generator).resume(()) {
            GeneratorState::Complete("foo") => {}
            _ => panic!("unexpected return from resume"),
        }
    }

Run

More documentation of generators can be found in the unstable book.

## Associated Types

### `type Yield`

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

The type of value this generator yields.

This associated type corresponds to the `yield` expression and the values which are allowed to be returned each time a generator yields. For example an iterator-as-a-generator would likely have this type as `T`, the type being iterated over.

### `type Return`

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

The type of value this generator returns.

This corresponds to the type returned from a generator either with a `return` statement or implicitly as the last expression of a generator literal. For example futures would use this as `Result<T, E>` as it represents a completed future.

Loading content...

## Required methods

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

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

Resumes the execution of this generator.

This function will resume execution of the generator or start execution if it hasn't already. This call will return back into the generator's last suspension point, resuming execution from the latest `yield`. The generator will continue executing until it either yields or returns, at which point this function will return.

# Return value

The `GeneratorState` enum returned from this function indicates what state the generator is in upon returning. If the `Yielded` variant is returned then the generator has reached a suspension point and a value has been yielded out. Generators in this state are available for resumption at a later point.

If `Complete` is returned then the generator has completely finished with the value provided. It is invalid for the generator to be resumed again.

# Panics

This function may panic if it is called after the `Complete` variant has been returned previously. While generator literals in the language are guaranteed to panic on resuming after `Complete`, this is not guaranteed for all implementations of the `Generator` trait.

Loading content...

## Implementors

### `impl<'_, G, R> Generator<R> for &'_ mut G where
G: Unpin + Generator<R> + ?Sized,` [src]

#### `type Yield = <G as Generator<R>>::Yield`

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

#### `type Return = <G as Generator<R>>::Return`

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

#### `fn resume(
self: Pin<&mut &'_ mut G>,
arg: R
) -> GeneratorState<<&'_ mut G as Generator<R>>::Yield, <&'_ mut G as Generator<R>>::Return>`[src]

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

### `impl<'_, G, R> Generator<R> for Pin<&'_ mut G> where
G: Generator<R> + ?Sized,` [src]

#### `type Yield = <G as Generator<R>>::Yield`

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

#### `type Return = <G as Generator<R>>::Return`

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

#### `fn resume(
self: Pin<&mut Pin<&'_ mut G>>,
arg: R
) -> GeneratorState<<Pin<&'_ mut G> as Generator<R>>::Yield, <Pin<&'_ mut G> as Generator<R>>::Return>`[src]

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

### `impl<G, R> Generator<R> for Box<G> where
G: Unpin + Generator<R> + ?Sized,` [src]

#### `type Yield = <G as Generator<R>>::Yield`

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

#### `type Return = <G as Generator<R>>::Return`

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

#### `fn resume(
self: Pin<&mut Box<G>>,
arg: R
) -> GeneratorState<<Box<G> as Generator<R>>::Yield, <Box<G> as Generator<R>>::Return>`[src]

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

### `impl<G, R> Generator<R> for Pin<Box<G>> where
G: Generator<R> + ?Sized,` [src]

#### `type Yield = <G as Generator<R>>::Yield`

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

#### `type Return = <G as Generator<R>>::Return`

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

#### `fn resume(
self: Pin<&mut Pin<Box<G>>>,
arg: R
) -> GeneratorState<<Pin<Box<G>> as Generator<R>>::Yield, <Pin<Box<G>> as Generator<R>>::Return>`[src]

🔬 This is a nightly-only experimental API. (`generator_trait` #43122)
Loading content...