Skip to main content

DataResource

Enum DataResource 

Source
pub enum DataResource<T> {
    Empty,
    Loading,
    Loaded(T),
    Failed(String),
}
Expand description

Represents the lifecycle of async-loaded data.

This type captures the four states data can be in:

  • Empty: No data requested yet
  • Loading: Data is being fetched
  • Loaded(T): Data successfully loaded
  • Failed(String): Loading failed with error message

Variants§

§

Empty

No data requested yet

§

Loading

Data is being fetched

§

Loaded(T)

Data successfully loaded

§

Failed(String)

Loading failed with error message

Implementations§

Source§

impl<T> DataResource<T>

Source

pub fn is_empty(&self) -> bool

Returns true if this is Empty.

Source

pub fn is_loading(&self) -> bool

Returns true if this is Loading.

Source

pub fn is_loaded(&self) -> bool

Returns true if this is Loaded(_).

Source

pub fn is_failed(&self) -> bool

Returns true if this is Failed(_).

Source

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

Returns a reference to the loaded data, or None if not loaded.

Source

pub fn data_mut(&mut self) -> Option<&mut T>

Returns a mutable reference to the loaded data, or None if not loaded.

Source

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

Returns the error message if failed, or None otherwise.

Source

pub fn map<U>(self, f: impl FnOnce(T) -> U) -> DataResource<U>

Maps the loaded value using the provided function.

If Loaded(t), returns Loaded(f(t)). Otherwise returns the same state.

Source

pub fn map_ref<U>(&self, f: impl FnOnce(&T) -> U) -> DataResource<U>

Maps a reference to the loaded value.

Source

pub fn and_then<U>( self, f: impl FnOnce(T) -> DataResource<U>, ) -> DataResource<U>

Applies a function that returns a DataResource to the loaded value.

Useful for chaining dependent async operations.

Source

pub fn unwrap_or(self, default: T) -> T

Returns the loaded value or a default.

Source

pub fn unwrap_or_else(self, f: impl FnOnce() -> T) -> T

Returns the loaded value or computes a default.

Source

pub fn as_ref(&self) -> DataResource<&T>

Converts from &DataResource<T> to DataResource<&T>.

Source

pub fn is_settled(&self) -> bool

Returns true if there’s either data or an error (not empty or loading).

Source

pub fn is_pending(&self) -> bool

Returns true if there’s no data yet (empty or loading).

Source

pub fn start_loading(&mut self) -> bool
where T: Clone,

Transitions to Loading state. Returns true if state actually changed.

Useful in reducers to start a fetch:

if resource.start_loading() {
    // dispatch effect to fetch
}
Source§

impl<T> DataResource<T>
where T: Clone,

Source

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

Returns a clone of the loaded data, or None if not loaded.

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Debug for DataResource<T>
where T: Debug,

Source§

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

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

impl<T> Default for DataResource<T>

Source§

fn default() -> DataResource<T>

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

impl<T> Hash for DataResource<T>
where T: Hash,

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T> PartialEq for DataResource<T>
where T: PartialEq,

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<T> Eq for DataResource<T>
where T: Eq,

Source§

impl<T> StructuralPartialEq for DataResource<T>

Auto Trait Implementations§

§

impl<T> Freeze for DataResource<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for DataResource<T>
where T: RefUnwindSafe,

§

impl<T> Send for DataResource<T>
where T: Send,

§

impl<T> Sync for DataResource<T>
where T: Sync,

§

impl<T> Unpin for DataResource<T>
where T: Unpin,

§

impl<T> UnwindSafe for DataResource<T>
where T: UnwindSafe,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more