Struct foyer_memory::CacheBuilder

source ·

pub struct CacheBuilder<K, V, L, S>where
    K: Key,
    V: Value,
    L: CacheEventListener<K, V>,
    S: BuildHasher + Send + Sync + 'static,
{ /* private fields */ }

Implementations§

source §

impl<K, V> CacheBuilder<K, V, DefaultCacheEventListener<K, V>, RandomState>
where K: Key, V: Value,

source

pub fn new(capacity: usize) -> Self

source §

impl<K, V, L, S> CacheBuilder<K, V, L, S>
where K: Key, V: Value, L: CacheEventListener<K, V>, S: BuildHasher + Send + Sync + 'static,

source

pub fn with_shards(self, shards: usize) -> Self

Set in-memory cache sharding count. Entries will be distributed to different shards based on their hash. Operations on different shard can be parallelized.

source

pub fn with_eviction_config( self, eviction_config: impl Into<EvictionConfig> ) -> Self

Set in-memory cache eviction algorithm.

The default value is a general-used w-TinyLFU algorithm.

source

pub fn with_object_pool_capacity(self, object_pool_capacity: usize) -> Self

Set object pool for handles. The object pool is used to reduce handle allocation.

The optimized value is supposed to be equal to the max cache entry count.

The default value is 1024.

source

pub fn with_event_listener<OL>( self, event_listener: OL ) -> CacheBuilder<K, V, OL, S>
where OL: CacheEventListener<K, V>,

Set in-memory cache event listener.

source

pub fn with_hash_builder<OS>( self, hash_builder: OS ) -> CacheBuilder<K, V, L, OS>
where OS: BuildHasher + Send + Sync + 'static,

Set in-memory cache hash builder.

source

pub fn with_weighter(self, weighter: impl Weighter<K, V>) -> Self

Set in-memory cache weighter.

source

pub fn build(self) -> Cache<K, V, L, S>

Build in-memory cache with the given configuration.

Auto Trait Implementations§

§

impl<K, V, L, S> Freeze for CacheBuilder<K, V, L, S>
where L: Freeze, S: Freeze,

§

impl<K, V, L, S> !UnwindSafe for CacheBuilder<K, V, L, S>

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, U> Into 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> IntoEither for T

source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

source §