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

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

    #[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: 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]

Compares and returns the maximum of two values. Read more

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

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

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

#### `fn hash<__HYR: Hasher>(&self, __arg_0: &mut __HYR)`
[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

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
↑
  Move up in search results
↓
  Move down in search results
↹
  Switch tab
⏎
  Go to active search result
+ / -
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)