Enum core::ops::GeneratorState[][src]

#[lang = "generator_state"]
pub enum GeneratorState<Y, R> { Yielded(Y), Complete(R), }
🔬 This is a nightly-only experimental API. (generator_trait #43122)

The result of a generator resumption.

This enum is returned from the Generator::resume method and indicates the possible return values of a generator. Currently this corresponds to either a suspension point (Yielded) or a termination point (Complete).

Variants

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

The generator suspended with a value.

This state indicates that a generator has been suspended, and typically corresponds to a yield statement. The value provided in this variant corresponds to the expression passed to yield and allows generators to provide a value each time they yield.

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

The generator completed with a return value.

This state indicates that a generator has finished execution with the provided value. Once a generator has returned Complete it is considered a programmer error to call resume again.

Trait Implementations

impl<Y: Clone, R: Clone> Clone for GeneratorState<Y, R>
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl<Y: Copy, R: Copy> Copy for GeneratorState<Y, R>
[src]

impl<Y: PartialEq, R: PartialEq> PartialEq for GeneratorState<Y, R>
[src]

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

impl<Y: PartialOrd, R: PartialOrd> PartialOrd for GeneratorState<Y, R>
[src]

This method returns an ordering between self and other values if one exists. Read more

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl<Y: Eq, R: Eq> Eq for GeneratorState<Y, R>
[src]

impl<Y: Ord, R: Ord> Ord for GeneratorState<Y, R>
[src]

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

impl<Y: Debug, R: Debug> Debug for GeneratorState<Y, R>
[src]

Formats the value using the given formatter. Read more

impl<Y: Hash, R: Hash> Hash for GeneratorState<Y, R>
[src]

Feeds this value into the given [Hasher]. Read more

Feeds a slice of this type into the given [Hasher]. Read more

Auto Trait Implementations

impl<Y, R> Send for GeneratorState<Y, R> where
    R: Send,
    Y: Send

impl<Y, R> Sync for GeneratorState<Y, R> where
    R: Sync,
    Y: Sync