Struct QueryOptions

pub struct QueryOptions<V> {
    pub default_value: Option<V>,
    pub stale_time: Option<Duration>,
    pub gc_time: Option<Duration>,
    pub refetch_interval: Option<Duration>,
    pub resource_option: Option<ResourceOption>,
}

Options for a query use_query()

Fields

default_value: Option<V>

Placeholder value to use while the query is loading for the first time.

stale_time: Option<Duration>

The duration that should pass before a query is considered stale. If the query is stale, it will be refetched. If no stale_time, the query will never be considered stale. Stale time is checked when use_query() instance is mounted. Stale_time can never be greater than cache_time. Default is 10 seconds. NOTE: If different stale_time are used for the same key, the MINIMUM time will be used.

gc_time: Option<Duration>

The amount of time a query will be cached, once it’s considered stale. If no cache time, the query will never be revoked from cache. cache_time can never be less than stale_time. Default is 5 minutes. NOTE: If different cache times are used for the same key, the MAXIMUM time will be used.

refetch_interval: Option<Duration>

If no refetch interval, the query will never refetch.

resource_option: Option<ResourceOption>

Determines which type of resource to use.

Implementations

impl<V> QueryOptions<V>

pub fn set_default_value(self, default_value: Option<V>) -> Self

Set the default value.

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

Set the stale_time.

pub fn set_gc_time(self, gc_time: Option<Duration>) -> Self

Set the gc time.

pub fn set_refetch_interval(self, refetch_interval: Option<Duration>) -> Self

Set the refetch interval.

pub fn set_resource_option( self, resource_option: Option<ResourceOption>, ) -> Self

Set the resource option.

pub fn map_value<R>(self, func: impl FnOnce(V) -> R) -> QueryOptions<R>

Transform the default value.

pub fn validate(self) -> Self

Ensures that gc_time is >= than stale_time.

Trait Implementations

impl<V: Clone> Clone for QueryOptions<V>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for QueryOptions<V>

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

Formats the value using the given formatter.

impl<V> Default for QueryOptions<V>

fn default() -> Self

Returns the “default value” for a type.