Enum core::ops::GeneratorState
[−]
[src]
#[lang = "generator_state"]pub enum GeneratorState<Y, R> { Yielded(Y), Complete(R), }
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)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)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]
fn clone(&self) -> GeneratorState<Y, R>[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
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]
fn eq(&self, __arg_0: &GeneratorState<Y, R>) -> bool[src]
This method tests for self and other values to be equal, and is used by ==. Read more
fn ne(&self, __arg_0: &GeneratorState<Y, R>) -> bool[src]
This method tests for !=.
impl<Y: PartialOrd, R: PartialOrd> PartialOrd for GeneratorState<Y, R>[src]
fn partial_cmp(&self, __arg_0: &GeneratorState<Y, R>) -> Option<Ordering>[src]
This method returns an ordering between self and other values if one exists. Read more
fn lt(&self, __arg_0: &GeneratorState<Y, R>) -> bool[src]
This method tests less than (for self and other) and is used by the < operator. Read more
fn le(&self, __arg_0: &GeneratorState<Y, R>) -> bool[src]
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
fn gt(&self, __arg_0: &GeneratorState<Y, R>) -> bool[src]
This method tests greater than (for self and other) and is used by the > operator. Read more
fn ge(&self, __arg_0: &GeneratorState<Y, R>) -> bool[src]
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]
fn cmp(&self, __arg_0: &GeneratorState<Y, R>) -> Ordering[src]
This method returns an Ordering between self and other. Read more
fn max(self, other: Self) -> Self where
Self: Sized, 1.21.0[src]
Self: Sized,
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self where
Self: Sized, 1.21.0[src]
Self: Sized,
Compares and returns the minimum of two values. Read more
impl<Y: Debug, R: Debug> Debug for GeneratorState<Y, R>[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result[src]
Formats the value using the given formatter. Read more