Enum core::ops::GeneratorState
source · [−]pub enum GeneratorState<Y, R> {
Yielded(Y),
Complete(R),
}
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)
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
sourceimpl<Y: Clone, R: Clone> Clone for GeneratorState<Y, R>
impl<Y: Clone, R: Clone> Clone for GeneratorState<Y, R>
sourcefn clone(&self) -> GeneratorState<Y, R>
fn clone(&self) -> GeneratorState<Y, R>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<Y: Debug, R: Debug> Debug for GeneratorState<Y, R>
impl<Y: Debug, R: Debug> Debug for GeneratorState<Y, R>
sourceimpl<Y: Hash, R: Hash> Hash for GeneratorState<Y, R>
impl<Y: Hash, R: Hash> Hash for GeneratorState<Y, R>
sourceimpl<Y: Ord, R: Ord> Ord for GeneratorState<Y, R>
impl<Y: Ord, R: Ord> Ord for GeneratorState<Y, R>
sourcefn cmp(&self, other: &GeneratorState<Y, R>) -> Ordering
fn cmp(&self, other: &GeneratorState<Y, R>) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self where
Self: Sized,
fn max(self, other: Self) -> Self where
Self: Sized,
Compares and returns the maximum of two values. Read more
sourceimpl<Y: PartialEq, R: PartialEq> PartialEq<GeneratorState<Y, R>> for GeneratorState<Y, R>
impl<Y: PartialEq, R: PartialEq> PartialEq<GeneratorState<Y, R>> for GeneratorState<Y, R>
sourcefn eq(&self, other: &GeneratorState<Y, R>) -> bool
fn eq(&self, other: &GeneratorState<Y, R>) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GeneratorState<Y, R>) -> bool
fn ne(&self, other: &GeneratorState<Y, R>) -> bool
This method tests for !=
.
sourceimpl<Y: PartialOrd, R: PartialOrd> PartialOrd<GeneratorState<Y, R>> for GeneratorState<Y, R>
impl<Y: PartialOrd, R: PartialOrd> PartialOrd<GeneratorState<Y, R>> for GeneratorState<Y, R>
sourcefn partial_cmp(&self, other: &GeneratorState<Y, R>) -> Option<Ordering>
fn partial_cmp(&self, other: &GeneratorState<Y, R>) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl<Y: Copy, R: Copy> Copy for GeneratorState<Y, R>
impl<Y: Eq, R: Eq> Eq for GeneratorState<Y, R>
impl<Y, R> StructuralEq for GeneratorState<Y, R>
impl<Y, R> StructuralPartialEq for GeneratorState<Y, R>
Auto Trait Implementations
impl<Y, R> RefUnwindSafe for GeneratorState<Y, R> where
R: RefUnwindSafe,
Y: RefUnwindSafe,
impl<Y, R> Send for GeneratorState<Y, R> where
R: Send,
Y: Send,
impl<Y, R> Sync for GeneratorState<Y, R> where
R: Sync,
Y: Sync,
impl<Y, R> Unpin for GeneratorState<Y, R> where
R: Unpin,
Y: Unpin,
impl<Y, R> UnwindSafe for GeneratorState<Y, R> where
R: UnwindSafe,
Y: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more