core::ops::GeneratorState - Rust
Description: API documentation for the Rust `GeneratorState` enum in crate `core`.
Keywords: rust, rustlang, rust-lang, GeneratorState

# [−][src]Enum core::ops::GeneratorState

    #[lang = "generator_state"]pub enum GeneratorState<Y, R> {
        Yielded(Y),
        Complete(R),
    }

🔬 This is a nightly-only experimental API. (`generator_trait` #43122)

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

### `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: Debug, R: Debug> Debug for GeneratorState<Y, R>`[src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result`[src]

Formats the value using the given formatter. Read more

### `impl<Y: Eq, R: Eq> Eq for GeneratorState<Y, R>`[src]

### `impl<Y: Hash, R: Hash> Hash for GeneratorState<Y, R>`[src]

#### `fn hash<__H: Hasher>(&self, state: &mut __H)`[src]

Feeds this value into the given [`Hasher`]. Read more

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

Feeds a slice of this type into the given [`Hasher`]. Read more

### `impl<Y: Ord, R: Ord> Ord for GeneratorState<Y, R>`[src]

#### `fn cmp(&self, other: &GeneratorState<Y, R>) -> Ordering`[src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `#[must_use]fn max(self, other: Self) -> Self where
Self: Sized,` 1.21.0[src]

Compares and returns the maximum of two values. Read more

#### `#[must_use]fn min(self, other: Self) -> Self where
Self: Sized,` 1.21.0[src]

Compares and returns the minimum of two values. Read more

#### `#[must_use]fn clamp(self, min: Self, max: Self) -> Self where
Self: Sized,` [src]

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

Restrict a value to a certain interval. Read more

### `impl<Y: PartialEq, R: PartialEq> PartialEq<GeneratorState<Y, R>> for GeneratorState<Y, R>`[src]

#### `fn eq(&self, other: &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, other: &GeneratorState<Y, R>) -> bool`[src]

This method tests for `!=`.

### `impl<Y: PartialOrd, R: PartialOrd> PartialOrd<GeneratorState<Y, R>> for GeneratorState<Y, R>`[src]

#### `fn partial_cmp(&self, other: &GeneratorState<Y, R>) -> Option<Ordering>`[src]

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

#### `fn lt(&self, other: &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, other: &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, other: &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, other: &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, R> StructuralEq for GeneratorState<Y, R>`[src]

### `impl<Y, R> StructuralPartialEq for GeneratorState<Y, R>`[src]

## Auto Trait Implementations

### `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,`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&Self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&Self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut Self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `fn from(T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(Self) -> U`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `fn try_into(Self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.