Enum next_gen::prelude::GeneratorState

pub enum GeneratorState<Yield, Return = ()> {
    Yield(Yield),
    Return(Return),
}

Value obtained when polling a GeneratorFn.

This corresponds to:

• either a suspension point,

• or a termination point

Variants

Yield(Yield)

The Generator suspended with a value.

This state indicates that a Generator has been suspended, and 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_!.

Return(Return)

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 Return, it is considered a programmer error to call .resume() again.

Trait Implementations

impl<Yield: Clone, Return: Clone> Clone for GeneratorState<Yield, Return>

fn clone(&self) -> GeneratorState<Yield, Return>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Yield: Copy, Return: Copy> Copy for GeneratorState<Yield, Return>

impl<Yield: Eq, Return: Eq> Eq for GeneratorState<Yield, Return>

impl<Yield: Ord, Return: Ord> Ord for GeneratorState<Yield, Return>

fn cmp(&self, other: &GeneratorState<Yield, Return>) -> 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

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

Restrict a value to a certain interval.

impl<Yield: PartialEq, Return: PartialEq> PartialEq<GeneratorState<Yield, Return>> for GeneratorState<Yield, Return>

fn eq(&self, other: &GeneratorState<Yield, Return>) -> bool

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

fn ne(&self, other: &GeneratorState<Yield, Return>) -> bool

This method tests for !=.

impl<Yield: PartialOrd, Return: PartialOrd> PartialOrd<GeneratorState<Yield, Return>> for GeneratorState<Yield, Return>

fn partial_cmp(&self, other: &GeneratorState<Yield, Return>) -> Option<Ordering>

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

fn lt(&self, other: &GeneratorState<Yield, Return>) -> bool

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

fn le(&self, other: &GeneratorState<Yield, Return>) -> bool

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

fn gt(&self, other: &GeneratorState<Yield, Return>) -> bool

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

fn ge(&self, other: &GeneratorState<Yield, Return>) -> bool

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

impl<Yield: Debug, Return: Debug> Debug for GeneratorState<Yield, Return>

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

Formats the value using the given formatter.

impl<Yield: Hash, Return: Hash> Hash for GeneratorState<Yield, Return>

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

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<Yield, Return> StructuralPartialEq for GeneratorState<Yield, Return>

impl<Yield, Return> StructuralEq for GeneratorState<Yield, Return>