Skip to main content

CoroutineState

Enum CoroutineState 

Source
pub enum CoroutineState<Y, R> {
    Yielded(Y),
    Complete(R),
}
๐Ÿ”ฌThis is a nightly-only experimental API. (coroutine_trait #43122)
Expand description

The result of a coroutine resumption.

This enum is returned from the Coroutine::resume method and indicates the possible return values of a coroutine. Currently this corresponds to either a suspension point (Yielded) or a termination point (Complete).

Variantsยง

ยง

Yielded(Y)

๐Ÿ”ฌThis is a nightly-only experimental API. (coroutine_trait #43122)

The coroutine suspended with a value.

This state indicates that a coroutine 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 coroutines to provide a value each time they yield.

ยง

Complete(R)

๐Ÿ”ฌThis is a nightly-only experimental API. (coroutine_trait #43122)

The coroutine completed with a return value.

This state indicates that a coroutine has finished execution with the provided value. Once a coroutine has returned Complete it is considered a programmer error to call resume again.

Trait Implementationsยง

Sourceยง

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

Sourceยง

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

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Returns a duplicate of the value. Read more
1.0.0 ยท Sourceยง

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

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Performs copy-assignment from source. Read more
Sourceยง

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

Sourceยง

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

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Formats the value using the given formatter. Read more
Sourceยง

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

Sourceยง

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

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
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,

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Feeds a slice of this type into the given Hasher. Read more
Sourceยง

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

Sourceยง

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

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
This method returns an Ordering between self and other. Read more
1.21.0 ยท Sourceยง

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

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Compares and returns the maximum of two values. Read more
1.21.0 ยท Sourceยง

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

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Compares and returns the minimum of two values. Read more
1.50.0 ยท Sourceยง

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Restrict a value to a certain interval. Read more
Sourceยง

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

Sourceยง

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

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Tests for self and other values to be equal, and is used by ==.
1.0.0 ยท Sourceยง

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

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
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 for CoroutineState<Y, R>

Sourceยง

fn partial_cmp(&self, other: &CoroutineState<Y, R>) -> Option<Ordering>

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
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 item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
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 item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
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 item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
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 item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
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 CoroutineState<Y, R>

Sourceยง

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

Sourceยง

impl<Y, R> StructuralPartialEq for CoroutineState<Y, R>

Auto Trait Implementationsยง

ยง

impl<Y, R> Freeze for CoroutineState<Y, R>
where Y: Freeze, R: Freeze,

ยง

impl<Y, R> RefUnwindSafe for CoroutineState<Y, R>

ยง

impl<Y, R> Send for CoroutineState<Y, R>
where Y: Send, R: Send,

ยง

impl<Y, R> Sync for CoroutineState<Y, R>
where Y: Sync, R: Sync,

ยง

impl<Y, R> Unpin for CoroutineState<Y, R>
where Y: Unpin, R: Unpin,

ยง

impl<Y, R> UnsafeUnpin for CoroutineState<Y, R>
where Y: UnsafeUnpin, R: UnsafeUnpin,

ยง

impl<Y, R> UnwindSafe for CoroutineState<Y, R>
where Y: UnwindSafe, R: UnwindSafe,

Blanket Implementationsยง

Sourceยง

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

Sourceยง

fn type_id(&self) -> TypeId

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Gets the TypeId of self. Read more
Sourceยง

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

Sourceยง

fn borrow(&self) -> &T

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Immutably borrows from an owned value. Read more
Sourceยง

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

Sourceยง

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

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Mutably borrows from an owned value. Read more
Sourceยง

impl<T> CloneToUninit for T
where T: Clone,

Sourceยง

unsafe fn clone_to_uninit(&self, dest: *mut u8)

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit #126799)
This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Performs copy-assignment from self to dest. Read more
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).

Returns the argument unchanged.

Sourceยง

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

Sourceยง

fn into(self) -> U

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).

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 T
where U: Into<T>,

Sourceยง

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>

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Performs the conversion.
Sourceยง

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

Sourceยง

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>

This item is validated for IEC 61508 (SIL 2) and ISO 26262 (ASIL B).
Performs the conversion.