Enum State

pub enum State<Y, T> {
    Yield(Y),
    Complete(T),
}

Represents the state of a coroutine, which can either yield a value of type Y or complete with a value of type T.

Variants

Yield(Y)

The coroutine yielded a value of type Y.

Complete(T)

The coroutine completed with a value of type T.

Implementations

impl<Y, T> State<Y, T>

pub fn as_yield(&self) -> Option<&Y>

Returns Some with the yielded value if the state is [Yield], otherwise None.

pub fn as_complete(&self) -> Option<&T>

Returns Some with the completed value if the state is [Complete], otherwise None.

pub fn is_yield(&self) -> bool

Returns true if the state is [Yield].

pub fn is_complete(&self) -> bool

Returns true if the state is [Complete].

impl<T> State<T, T>

pub fn value(self) -> T

Returns the value contained in the state, regardless of whether it is a yield or complete state.

Trait Implementations

impl<Y: Debug, T: Debug> Debug for State<Y, T>

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

Formats the value using the given formatter.

impl<Y: PartialEq, T: PartialEq> PartialEq for State<Y, T>

fn eq(&self, other: &State<Y, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Y: Eq, T: Eq> Eq for State<Y, T>

impl<Y, T> StructuralPartialEq for State<Y, T>