Skip to main content

AsyncValue

Enum AsyncValue 

Source
pub enum AsyncValue<T> {
    Idle,
    Loading(Option<T>),
    Ready(T),
    Error(TaskError),
}
Expand description

The exhaustive state of an asynchronously-loaded value.

Deliberately named for parity with Riverpod’s AsyncValue<T> (Flutter) — the genuine prior art for a load/data/error sum type with exhaustive matching (research §9). The four states are:

  • Idle — nothing requested yet.
  • Loading — a fetch is in flight. It carries the previous value (Some on a refresh, None on a first load), so a UI can keep showing stale data instead of flickering to a spinner — mirroring Riverpod’s copyWithPrevious.
  • Ready — the fetch resolved to a value.
  • Error — the fetch failed.

Variants§

§

Idle

No fetch requested yet.

§

Loading(Option<T>)

A fetch is in flight; carries the previous value for refresh-without-flicker (None on a first load).

§

Ready(T)

The fetch resolved.

§

Error(TaskError)

The fetch failed.

Implementations§

Source§

impl<T> AsyncValue<T>

Source

pub fn is_idle(&self) -> bool

Whether this is Idle.

Source

pub fn is_loading(&self) -> bool

Whether a fetch is in flight.

Source

pub fn is_ready(&self) -> bool

Whether the fetch resolved to a value.

Source

pub fn is_error(&self) -> bool

Whether the fetch failed.

Source

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

The resolved value, if Ready.

Source

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

The best-available value: the resolved one when Ready, or the carried-over previous one while Loading a refresh. This is what a flicker-free UI reads.

Source

pub fn error(&self) -> Option<&TaskError>

The error, if Error.

Trait Implementations§

Source§

impl<T: Clone> Clone for AsyncValue<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for AsyncValue<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Default for AsyncValue<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for AsyncValue<T>

§

impl<T> !UnwindSafe for AsyncValue<T>

§

impl<T> Freeze for AsyncValue<T>
where Option<T>: Freeze, T: Freeze,

§

impl<T> Send for AsyncValue<T>
where Option<T>: Send, T: Send,

§

impl<T> Sync for AsyncValue<T>
where Option<T>: Sync, T: Sync,

§

impl<T> Unpin for AsyncValue<T>
where Option<T>: Unpin, T: Unpin,

§

impl<T> UnsafeUnpin for AsyncValue<T>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

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

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)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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>

Performs the conversion.