Enum std::ops::GeneratorState
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.
Tuple Fields of Yielded
0: YComplete(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.
Tuple Fields of Complete
0: RTrait Implementations
pub fn clone(&self) -> GeneratorState<Y, R>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
pub fn cmp(&self, other: &GeneratorState<Y, R>) -> Ordering
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
fn clamp(self, min: Self, max: Self) -> Self
Restrict a value to a certain interval. Read more
pub 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
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
R: PartialOrd<R>,
Y: PartialOrd<Y>,
pub 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
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self and other) and is used by the < operator. Read more
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
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self and other) and is used by the > operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
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> UnwindSafe for GeneratorState<Y, R> where
R: UnwindSafe,
Y: UnwindSafe,
Blanket Implementations
impl<T> From<T> for T
pub fn from(t: T) -> T
Performs the conversion.
pub fn into(self) -> U
Performs the conversion.
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
toowned_clone_into #41263)recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/ops/enum.GeneratorState.html