Struct Query

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

Implementations

impl<Q: QueryCapability> Query<Q>

pub fn new(keys: Q::Keys, query: Q) -> Self

pub fn enable(self, enabled: bool) -> Self

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

Defaults to true.

pub fn stale_time(self, stale_time: Duration) -> Self

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) -> Self

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) -> Self

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 + QueryCapability> Clone for Query<Q>

where Q::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: QueryCapability> From<GetQuery<Q>> for Query<Q>

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

Converts to this type from the input type.

impl<Q: QueryCapability> Hash for Query<Q>

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

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 + QueryCapability> PartialEq for Query<Q>

where Q::Keys: PartialEq,

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: QueryCapability> Eq for Query<Q>

impl<Q: QueryCapability> StructuralPartialEq for Query<Q>