Enum breadx::display::AsyncStatus

pub enum AsyncStatus<T> {
    Ready(T),
    Read,
    Write,
    UserControlled,
}

The status of an async function.

An async function can either be ready, or be unready for a number of reasons. This enum is used to represent the status of an async function.

It can be thought of as similar to Poll, but instead of returning Pending, it returns the exact reason why it is pending.

Variants

Ready(T)

The function’s result is ready.

Read

We are waiting for a read to be available.

Write

We are waiting for a write to be available.

UserControlled

We are waiting for something else.

The implementation is expected to wake the provided waker once the function is ready to be called again.

Implementations

impl<T> AsyncStatus<T>

pub fn is_ready(&self) -> bool

Returns true if the AsyncStatus is Ready.

pub fn map<R>(self, f: impl FnOnce(T) -> R) -> AsyncStatus<R>

Maps the AsyncStatus from one type to another, if the AsyncStatus is Ready.

pub fn unwrap(self) -> T

Unwrap the AsyncStatus, returning the inner value or panicking otherwise.

Panics

Panics if the AsyncStatus is not Ready.

pub fn ready(self) -> Option<T>

Convert the AsyncStatus into an Option.

impl<T: Copy> AsyncStatus<&T>

pub fn copied(self) -> AsyncStatus<T>

Copy the reference in an AsyncStatus to a value.

Trait Implementations

impl<T: Clone> Clone for AsyncStatus<T>

fn clone(&self) -> AsyncStatus<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for AsyncStatus<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for AsyncStatus<T>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for AsyncStatus<T>

fn cmp(&self, other: &AsyncStatus<T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<AsyncStatus<T>> for AsyncStatus<T>

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &AsyncStatus<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<AsyncStatus<T>> for AsyncStatus<T>

fn partial_cmp(&self, other: &AsyncStatus<T>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: Copy> Copy for AsyncStatus<T>

impl<T: Eq> Eq for AsyncStatus<T>

impl<T> StructuralEq for AsyncStatus<T>

impl<T> StructuralPartialEq for AsyncStatus<T>