DataLoader

Struct DataLoader 

Source
pub struct DataLoader<T, C = NoCache> { /* private fields */ }
Available on crate feature dataloader only.
Expand description

Implementations§

Source§

impl<T> DataLoader<T, NoCache>

Source

pub fn new<S, TR>(loader: T, spawner: S, timer: TR) -> Self
where S: Spawn + Send + Sync + 'static, TR: Timer,

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

Source§

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

Source

pub fn with_cache<S, TR>( loader: T, spawner: S, timer: TR, cache_factory: C, ) -> Self
where S: Spawn + Send + Sync + 'static, TR: Timer,

Use Loader to create a DataLoader with a cache factory.

Source

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

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

Source

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.

Source

pub fn loader(&self) -> &T

Get the loader.

Source

pub fn enable_all_cache(&self, enable: bool)

Enable/Disable cache of all loaders.

Source

pub async fn enable_cache<K>(&self, enable: bool)
where K: Send + Sync + Hash + Eq + Clone + 'static, T: Loader<K>,

Enable/Disable cache of specified loader.

Source

pub async fn load_one<K>(&self, key: K) -> Result<Option<T::Value>, T::Error>
where K: Send + Sync + Hash + Eq + Clone + 'static, T: Loader<K>,

Use this DataLoader load a data.

Source

pub async fn load_many<K, I>( &self, keys: I, ) -> Result<HashMap<K, T::Value>, T::Error>
where K: Send + Sync + Hash + Eq + Clone + 'static, I: IntoIterator<Item = K>, T: Loader<K>,

Use this DataLoader to load some data.

Source

pub async fn feed_many<K, I>(&self, values: I)
where K: Send + Sync + Hash + Eq + Clone + 'static, I: IntoIterator<Item = (K, T::Value)>, T: Loader<K>,

Feed some data into the cache.

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

Source

pub async fn feed_one<K>(&self, key: K, value: T::Value)
where K: Send + Sync + Hash + Eq + Clone + 'static, T: Loader<K>,

Feed some data into the cache.

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

Source

pub fn clear<K>(&self)
where K: Send + Sync + Hash + Eq + Clone + 'static, T: Loader<K>,

Clears the cache.

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

Source

pub async fn get_cached_values<K>(&self) -> HashMap<K, T::Value>
where K: Send + Sync + Hash + Eq + Clone + 'static, T: Loader<K>,

Gets all values in the cache.

Auto Trait Implementations§

§

impl<T, C = NoCache> !Freeze for DataLoader<T, C>

§

impl<T, C = NoCache> !RefUnwindSafe for DataLoader<T, C>

§

impl<T, C> Send for DataLoader<T, C>
where C: Send, T: Sync + Send,

§

impl<T, C> Sync for DataLoader<T, C>
where C: Sync, T: Sync + Send,

§

impl<T, C> Unpin for DataLoader<T, C>
where C: Unpin,

§

impl<T, C = NoCache> !UnwindSafe for DataLoader<T, C>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more