Struct DataLoader

pub struct DataLoader<T, C = NoCache> { /* private fields */ }

Data loader.

Reference: https://github.com/facebook/dataloader

Implementations

impl<T> DataLoader<T, NoCache>

pub fn new<S, R>(loader: T, spawner: S) -> Self

where S: Fn(BoxFuture<'static, ()>) -> R + Send + Sync + 'static,

Use Loader to create a DataLoader that does not cache records.

impl<T, C: CacheFactory> DataLoader<T, C>

pub fn with_cache<S, R>(loader: T, spawner: S, cache_factory: C) -> Self

where S: Fn(BoxFuture<'static, ()>) -> R + Send + Sync + 'static,

Use Loader to create a DataLoader with a cache factory.

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

Specify the delay time for loading data, the default is 1ms.

pub fn max_batch_size(self, max_batch_size: usize) -> Self

pub fn Specify the max batch size for loading data, the default is 1000.

If the keys waiting to be loaded reach the threshold, they are loaded immediately.

pub fn loader(&self) -> &T

Get the loader.

pub fn enable_all_cache(&self, enable: bool)

Enable/Disable cache of all loaders.

pub fn enable_cache<K, V>(&self, enable: bool)

where K: Send + Sync + Hash + Eq + Clone + 'static, V: Send + Sync + Clone + 'static, T: Loader<K, V>,

Enable/Disable cache of specified loader.

pub async fn load_one<K, V>(&self, key: K) -> Result<Option<V>, T::Error>

where K: Send + Sync + Hash + Eq + Clone + 'static, V: Send + Sync + Clone + 'static, T: Loader<K, V>,

Use this DataLoader load a data.

pub async fn load_many<K, V, I>( &self, keys: I, ) -> Result<HashMap<K, V>, T::Error>

where K: Send + Sync + Hash + Eq + Clone + 'static, I: IntoIterator<Item = K>, V: Send + Sync + Clone + 'static, T: Loader<K, V>,

Use this DataLoader to load some data.

pub async fn feed_many<K, V, I>(&self, values: I)

where K: Send + Sync + Hash + Eq + Clone + 'static, I: IntoIterator<Item = (K, V)>, V: Send + Sync + Clone + 'static, T: Loader<K, V>,

Feed some data into the cache.

**NOTE: If the cache type is NoCache, this function will not take effect. **

pub async fn feed_one<K, V>(&self, key: K, value: V)

where K: Send + Sync + Hash + Eq + Clone + 'static, V: Send + Sync + Clone + 'static, T: Loader<K, V>,

Feed some data into the cache.

**NOTE: If the cache type is NoCache, this function will not take effect. **

pub fn clear<K, V>(&self)

where K: Send + Sync + Hash + Eq + Clone + 'static, V: Send + Sync + Clone + 'static, T: Loader<K, V>,

Clears the cache.

**NOTE: If the cache type is NoCache, this function will not take effect. **

pub fn get_cached_values<K, V>(&self) -> HashMap<K, V>

where K: Send + Sync + Hash + Eq + Clone + 'static, V: Send + Sync + Clone + 'static, T: Loader<K, V>,

Gets all values in the cache.