Enum leptos_query::QueryState

pub enum QueryState<V> {
    Created,
    Loading,
    Fetching(QueryData<V>),
    Loaded(QueryData<V>),
    Invalid(QueryData<V>),
}

The lifecycle of a query.

Each variant in the enum corresponds to a particular state of a query in its lifecycle, starting from creation and covering all possible transitions up to invalidation.

Variants

Created

The initial state of a Query upon its creation.

In this state, a query is instantiated but no fetching operation has been initiated yet. This means that no data has been requested or received, and the query is in a “pending” state, waiting to begin its first fetch operation.

Loading

Query is fetching for the first time.

In this state, the query has started its first data fetching process. It is actively communicating with the data source and waiting for the data to be returned.

Fetching(QueryData<V>)

A Query is in the process of fetching, not being its first fetch.

In this state, a query is undergoing another fetch operation following a previous one. The associated QueryData<V> object holds the previous data was fetched.

Loaded(QueryData<V>)

The state indicating that a query has successfully completed a fetch operation.

In this state, the query has finished fetching data. The associated QueryData<V> object holds the successfully loaded data.

Invalid(QueryData<V>)

The state indicating that a query has completed a fetch, but the fetched data is marked as invalid.

The associated QueryData<V> object holds the invalidated data.

Implementations

impl<V> QueryState<V>

pub fn query_data(&self) -> Option<&QueryData<V>>

Returns the QueryData for the current QueryState, if present.

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

Returns the data contained within the QueryState, if present.

pub fn updated_at(&self) -> Option<Instant>

Returns the last updated timestamp for the QueryState, if present.

Trait Implementations

impl<V: Clone> Clone for QueryState<V>

fn clone(&self) -> QueryState<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V> Debug for QueryState<V>

where V: Debug,

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

Formats the value using the given formatter.

impl<V: PartialEq> PartialEq for QueryState<V>

fn eq(&self, other: &QueryState<V>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<V: Eq> Eq for QueryState<V>

impl<V> StructuralPartialEq for QueryState<V>