Struct Query 

pub struct Query<Q>
where
    Q: QueryCapability,
{ /* private fields */ }

Available on crate feature query only.

Implementations

impl<Q> Query<Q>

where Q: QueryCapability,

pub fn new(keys: <Q as QueryCapability>::Keys, query: Q) -> Query<Q>

pub fn enable(self, enabled: bool) -> Query<Q>

Enable or disable this query so that it doesnt automatically run.

Defaults to true.

pub fn keep_old_data(self, keep_old_data: bool) -> Query<Q>

Keep displaying the previously fetched data when the keys change, while the new data loads.

When the keys of a mounted query change a fresh cache entry is created that would normally start empty. With this enabled the new entry is seeded with the last successful data, so subscribers keep showing it until the new keys settle.

Defaults to false.

pub fn stale_time(self, stale_time: Duration) -> Query<Q>

For how long is the data considered stale. If a query subscriber is mounted and the data is stale, it will re run the query otherwise it return the cached data.

Defaults to Duration::ZERO, meaning it is marked stale immediately after it has been used.

pub fn clean_time(self, clean_time: Duration) -> Query<Q>

For how long the data is kept cached after there are no more query subscribers.

Defaults to 5min, meaning it clears automatically after 5 minutes of no subscribers to it.

pub fn interval_time(self, interval_time: Duration) -> Query<Q>

Every how often the query reruns.

Defaults to Duration::MAX, meaning it never re runs automatically.

Note: If multiple subscribers of the same query use different intervals, only the shortest one will be used.

Trait Implementations

impl<Q> Clone for Query<Q>

where Q: Clone + QueryCapability, <Q as QueryCapability>::Keys: Clone,

fn clone(&self) -> Query<Q>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Q> From<GetQuery<Q>> for Query<Q>

where Q: QueryCapability,

fn from(value: GetQuery<Q>) -> Query<Q>

Converts to this type from the input type.

impl<Q> Hash for Query<Q>

where Q: QueryCapability,

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Q> PartialEq for Query<Q>

where Q: QueryCapability,

fn eq(&self, other: &Query<Q>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<Q> Eq for Query<Q>

where Q: QueryCapability,