Enum std::ops::GeneratorState

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

Yielded(Y)

Tuple Fields

0: Y

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

🔬 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.

Complete(R)

Tuple Fields

0: R

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

🔬 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> Clone for GeneratorState<Y, R> where
    Y: Clone,
    R: Clone, 

pub 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, R> Debug for GeneratorState<Y, R> where
    Y: Debug,
    R: Debug, 

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

Formats the value using the given formatter.

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

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

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

pub 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: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

fn ge(&self, other: &Rhs) -> bool

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

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

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

impl<Y, R> StructuralEq for GeneratorState<Y, R>

impl<Y, R> StructuralPartialEq for GeneratorState<Y, R>