Enum QueryStateData 

pub enum QueryStateData<Q>
where
    Q: QueryCapability,
{
    Pending,
    Loading {
        res: Option<Result<<Q as QueryCapability>::Ok, <Q as QueryCapability>::Err>>,
    },
    Settled {
        res: Result<<Q as QueryCapability>::Ok, <Q as QueryCapability>::Err>,
        settlement_instant: Instant,
    },
}

Available on crate feature query only.

Variants

Pending

Has not loaded yet.

Loading

Is loading and may not have a previous settled value.

Fields

res: Option<Result<<Q as QueryCapability>::Ok, <Q as QueryCapability>::Err>>

Settled

Is not loading and has a settled value.

Fields

res: Result<<Q as QueryCapability>::Ok, <Q as QueryCapability>::Err>

settlement_instant: Instant

Implementations

impl<Q> QueryStateData<Q>

where Q: QueryCapability,

pub fn is_ok(&self) -> bool

Check if the state is QueryStateData::Settled and Result::Ok.

pub fn is_err(&self) -> bool

Check if the state is QueryStateData::Settled and Result::Err.

pub fn is_loading(&self) -> bool

Check if the state is QueryStateData::Loading.

pub fn is_pending(&self) -> bool

Check if the state is QueryStateData::Pending.

pub fn is_stale(&self, query: &Query<Q>) -> bool

Check if the state is stale or not, where stale means outdated.

pub fn ok(&self) -> Option<&<Q as QueryCapability>::Ok>

Get the value as an Option.

pub fn unwrap( &self, ) -> &Result<<Q as QueryCapability>::Ok, <Q as QueryCapability>::Err>

Get the value as an Result if possible, otherwise it will panic.

Trait Implementations

impl<Q> Debug for QueryStateData<Q>

where Q: QueryCapability, <Q as QueryCapability>::Ok: Debug, <Q as QueryCapability>::Err: Debug,

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

Formats the value using the given formatter.

impl<Q> TryFrom<QueryStateData<Q>> for Result<<Q as QueryCapability>::Ok, <Q as QueryCapability>::Err>

where Q: QueryCapability,

type Error = ()

The type returned in the event of a conversion error.

fn try_from( value: QueryStateData<Q>, ) -> Result<Result<<Q as QueryCapability>::Ok, <Q as QueryCapability>::Err>, <Result<<Q as QueryCapability>::Ok, <Q as QueryCapability>::Err> as TryFrom<QueryStateData<Q>>>::Error>

Performs the conversion.