Enum core::ops::GeneratorState

[+] Show declaration

[+] Expand attributes
#[lang = "generator_state"]
pub enum GeneratorState<Y, R> {
    Yielded(Y),
    Complete(R),
}

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

[−] Expand description

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

Yielded(Y)

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

[−] Expand description

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.

Complete(R)

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

[−] Expand description

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: Copy, R: Copy> Copy for GeneratorState<Y, R>

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

[+] Show hidden undocumented items

fn eq(&self, other: &GeneratorState<Y, R>) -> bool[−]

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

fn ne(&self, other: &GeneratorState<Y, R>) -> bool[−]

This method tests for !=.

impl<Y: Eq, R: Eq> Eq for GeneratorState<Y, R>

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

[+] Show hidden undocumented items

fn cmp(&self, other: &GeneratorState<Y, R>) -> Ordering[−]

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self where
    Self: Sized, [−]

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self where
    Self: Sized, [−]

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: Sized, [−]

🔬 This is a nightly-only experimental API. (clamp #44095)

Restrict a value to a certain interval.

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

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &GeneratorState<Y, R>) -> Option<Ordering>[−]

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

fn lt(&self, other: &GeneratorState<Y, R>) -> bool[−]

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

fn le(&self, other: &GeneratorState<Y, R>) -> bool[−]

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

fn gt(&self, other: &GeneratorState<Y, R>) -> bool[−]

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

fn ge(&self, other: &GeneratorState<Y, R>) -> bool[−]

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

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

[+] Show hidden undocumented items

fn clone(&self) -> GeneratorState<Y, R>[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

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

[+] Show hidden undocumented items

fn hash<__HYR: Hasher>(&self, state: &mut __HYR)[−]

Feeds this value into the given [Hasher].

fn hash_slice<H: Hasher>(data: &[Self], state: &mut H) where
    Self: Sized, [−]

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

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

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.