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

# [−][src]Enum std::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, R> Hash for GeneratorState<Y, R> where R: Hash, Y: Hash,`

[src]

####

`fn hash<__HYR>(&self, state: &mut __HYR) where __HYR: Hasher,`

[src]

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

####

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

1.3.0
[src]

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

###

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

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result<(), Error>`

[src]

Formats the value using the given formatter. Read more

###

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

[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, R> PartialOrd<GeneratorState<Y, R>> for GeneratorState<Y, R> where R: PartialOrd<R>, Y: PartialOrd<Y>,`

[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> Ord for GeneratorState<Y, R> where R: Ord, Y: Ord,`

[src]

####

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

[src]

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

####

`fn max(self, other: Self) -> Self`

1.21.0
[src]

Compares and returns the maximum of two values. Read more

####

`fn min(self, other: Self) -> Self`

1.21.0
[src]

Compares and returns the minimum of two values. Read more

###

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

[src]

###

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

[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, R> Copy for GeneratorState<Y, R> where R: Copy, Y: Copy,`

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

## Blanket Implementations

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

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

[src]

Mutably borrows from an owned value. Read more

###

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

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

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

###

`impl<T> ToOwned for T where T: Clone,`

[src]

#### `type Owned = T`

####

`fn to_owned(&self) -> T`

[src]

Creates owned data from borrowed data, usually by cloning. Read more

####

`fn clone_into(&self, target: &mut T)`

[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. 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
`+`
  Expand all sections
`-`
  Collapse 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`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)