Struct async_graphql::dataloader::DataLoader

source · [−]

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

Available on crate feature dataloader only.

Expand description

Data loader.

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

Implementations

source

impl<T> DataLoader<T, NoCache>

source

pub fn new<S, R>(loader: T, spawner: S) -> Selfwhere
S: Fn(BoxFuture<'static, ()>) -> R + Send + Sync + 'static,

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, R>(loader: T, spawner: S, cache_factory: C) -> Selfwhere
S: Fn(BoxFuture<'static, ()>) -> R + Send + Sync + 'static,

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 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. **

Auto Trait Implementations

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

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

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

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 Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> FutureExt for T

source

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

source

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext 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> 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 for Twhere
U: From<T>,

const: unstable · 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<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

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

Struct async_graphql::dataloader::DataLoader

Implementations

impl<T> DataLoader<T, NoCache>

pub fn new<S, R>(loader: T, spawner: S) -> Selfwhere S: Fn(BoxFuture<'static, ()>) -> R + Send + Sync + 'static,

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

pub fn with_cache<S, R>(loader: T, spawner: S, cache_factory: C) -> Selfwhere S: Fn(BoxFuture<'static, ()>) -> R + Send + Sync + 'static,

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

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

pub fn loader(&self) -> &T

pub fn enable_all_cache(&self, enable: bool)

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

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>,

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>,

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>,

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

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

fn with_current_context(self) -> WithContext<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn new<S, R>(loader: T, spawner: S) -> Selfwhere
S: Fn(BoxFuture<'static, ()>) -> R + Send + Sync + 'static,

pub fn with_cache<S, R>(loader: T, spawner: S, cache_factory: C) -> Selfwhere
S: Fn(BoxFuture<'static, ()>) -> R + Send + Sync + 'static,

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

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>,

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>,

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>,

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

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

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

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

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

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

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

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

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

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

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

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

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

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