Skip to main content

LoaderConfig

Struct LoaderConfig 

Source
pub struct LoaderConfig { /* private fields */ }
Expand description

Limits for a Loader.

The defaults are intentionally conservative: 1,000 keys per batch is far more than an IN query should carry, and the queue limit only exists so a resolver that issues an unbounded number of loads in one tick cannot grow memory without bound.

Implementations§

Source§

impl LoaderConfig

Source

pub const fn new() -> Self

Create the default configuration.

Source

pub const fn with_max_batch_size(self, size: usize) -> Self

Set the maximum number of keys passed to one call of the batch function.

Zero is treated as one.

Source

pub const fn with_max_queue(self, size: usize) -> Self

Set the maximum number of keys queued before a flush is forced.

When the queue reaches this length the loader starts batches immediately instead of waiting for the next poll. Zero is treated as one. This bounds work waiting for the batch window; results are still cached per key for the loader’s lifetime, so it is not a cap on the number of distinct keys a request may load.

Source

pub const fn with_max_attempts(self, attempts: u8) -> Self

Set how many times a key may be retried when a batch function omits its result.

This only matters if the batch function violates its contract. Zero is treated as one.

Source

pub const fn max_batch_size(&self) -> usize

The maximum number of keys passed to one call of the batch function.

Source

pub const fn max_queue(&self) -> usize

The queue length that forces an immediate flush.

Source

pub const fn max_attempts(&self) -> u8

The maximum number of attempts for a key a batch function failed to answer.

Trait Implementations§

Source§

impl Clone for LoaderConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for LoaderConfig

Source§

impl Debug for LoaderConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LoaderConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for LoaderConfig

Source§

impl PartialEq for LoaderConfig

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LoaderConfig

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.