Enum std::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, R> PartialEq<GeneratorState<Y, R>> for GeneratorState<Y, R> where
    R: PartialEq<R>,
    Y: PartialEq<Y>, 
[src]

[src]

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

[src]

This method tests for !=.

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

[src]

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

[src]

This method tests for !=.

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

[src]

Formats the value using the given formatter.

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

[src]

Returns a copy of the value. Read more

1.0.0
[src]

Performs copy-assignment from source. Read more

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

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

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

[src]

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

1.3.0
[src]

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

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

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

[src]

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

1.21.0
[src]

Compares and returns the maximum of two values. Read more

1.21.0
[src]

Compares and returns the minimum of two values. Read more