Struct QueryScopeLocal

pub struct QueryScopeLocal<K, V> { /* private fields */ }

A non-threadsafe wrapper for a query function. This can be used to add specific QueryOptions to only apply to one query scope.

These QueryOptions will be combined with the global QueryOptions set on the crate::QueryClient, with the local options taking precedence.

If you don’t need to set specific options, you can use functions with the crate::QueryClient directly.

Implementations

impl<K, V> QueryScopeLocal<K, V>

pub fn new<M>(query_scope: impl QueryScopeLocalTrait<K, V, M> + 'static) -> Self

where K: 'static, V: 'static,

Create a new QueryScopeLocal . If the query fn does not have a key argument, K=()

pub fn with_options(self, options: QueryOptions) -> Self

Set specific QueryOptions to only apply to this query scope.

These QueryOptions will be combined with the global QueryOptions set on the crate::QueryClient, with the local options taking precedence.

pub fn with_invalidation_link<S, I>( self, invalidation_hierarchy_fn: impl Fn(&K) -> I + Send + Sync + 'static, ) -> Self

where I: IntoIterator<Item = S> + 'static, S: Into<String> + 'static,

Different query types are sometimes linked to the same source, e.g. you may want an invalidation of list_blogposts() to always automatically invalidate get_blogpost(id).

QueryScope::with_invalidation_link can be used to this effect, given a query key &K, you provide a Vec<String> that’s used as a hierarchy key (HK) for that query. When a query is invalidated, any query’s HK that’s prefixed by this HK will also be invalidated automatically. E.g. A query with HK ["users"] will also auto invalidate another query with ["users", "1"], but not the other way around. 2 queries with an identicial HK of ["users"] will auto invalidate each other.

use std::time::Duration;

use leptos_fetch::{QueryClient, QueryScope, QueryOptions};
use leptos::prelude::*;

#[derive(Debug, Clone)]
struct User;

fn list_users_query() -> QueryScope<(), Vec<User>> {
    QueryScope::new(async || vec![])
        .with_invalidation_link(
            |_key| ["users"]
        )
}

fn get_user_query() -> QueryScope<i32, User> {
    QueryScope::new(async move |user_id: i32| User)
        .with_invalidation_link(
            |user_id| ["users".to_string(), user_id.to_string()]
        )
}

let client = QueryClient::new();

// This invalidates only user "2", because ["users", "2"] is not a prefix of ["users"],
// list_users_query is NOT invalidated.
client.invalidate_query(get_user_query(), &2);

// This invalidates both queries, because ["users"] is a prefix of ["users", "$x"]
client.invalidate_query(list_users_query(), &());

pub fn with_title(self, title: impl Into<String>) -> Self

Available on crate features devtools or devtools-always only.

Set a custom query scope/type title that will show in devtools.

Trait Implementations

impl<K: Clone, V: Clone> Clone for QueryScopeLocal<K, V>

fn clone(&self) -> QueryScopeLocal<K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V> Debug for QueryScopeLocal<K, V>

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

Formats the value using the given formatter.