Enum core::ops::GeneratorState

source ·
pub enum GeneratorState<Y, R> {
    Yielded(Y),
    Complete(R),
}
🔬This is a nightly-only experimental API. (generator_trait #43122)
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)

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

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

source§

impl<Y: Clone, R: Clone> Clone for GeneratorState<Y, R>

source§

fn clone(&self) -> GeneratorState<Y, R>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<Y: Debug, R: Debug> Debug for GeneratorState<Y, R>

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

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

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

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

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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 · source§

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 · source§

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
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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
source§

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

source§

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

source§

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

source§

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§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
This documentation is an old archive. Please see https://rust.docs.kernel.org instead.