Enum ReadyOrNot

pub enum ReadyOrNot<F: Future> {
    Ready(F::Output),
    Not(F),
}

This type holds a future that has been detached from a group.

Variants

Ready(F::Output)

If the future has run to completion, this variant holds the future’s output.

Not(F)

If the future has not yet run to completion, this variant holds the future.

Implementations

impl<F: Future> ReadyOrNot<F>

pub async fn output(self) -> F::Output

A convenience method for retrieving the output of the future, either by driving the contained future to completion or by unwrapping the output value.

Note that this method does not drive the background futures of an async group. To drive the background futures, use Group::detach_and_wait_for instead of detaching the future separately.

Trait Implementations

impl<F: Debug + Future> Debug for ReadyOrNot<F>

where F::Output: Debug,

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

Formats the value using the given formatter.

impl<F: Ord + Future> Ord for ReadyOrNot<F>

where F::Output: Ord,

fn cmp(&self, other: &ReadyOrNot<F>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<F: PartialEq + Future> PartialEq for ReadyOrNot<F>

where F::Output: PartialEq,

fn eq(&self, other: &ReadyOrNot<F>) -> 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<F: PartialOrd + Future> PartialOrd for ReadyOrNot<F>

where F::Output: PartialOrd,

fn partial_cmp(&self, other: &ReadyOrNot<F>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<F: Eq + Future> Eq for ReadyOrNot<F>

where F::Output: Eq,

impl<F: Future> StructuralPartialEq for ReadyOrNot<F>