Struct foyer_memory::CacheBuilder

pub struct CacheBuilder<K, V, S>
where
    K: Key,
    V: Value,
    S: HashBuilder,
{ /* private fields */ }

In-memory cache builder.

Implementations

impl<K, V> CacheBuilder<K, V, RandomState>

where K: Key, V: Value,

pub fn new(capacity: usize) -> Self

Create a new in-memory cache builder.

impl<K, V, S> CacheBuilder<K, V, S>

where K: Key, V: Value, S: HashBuilder,

pub fn with_name(self, name: &str) -> Self

Set the name of the foyer in-memory cache instance.

Foyer will use the name as the prefix of the metric names.

Default: foyer.

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.

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.

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.

pub fn with_hash_builder<OS>(self, hash_builder: OS) -> CacheBuilder<K, V, OS>

where OS: HashBuilder,

Set in-memory cache hash builder.

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

Set in-memory cache weighter.

pub fn with_event_listener( self, event_listener: Arc<dyn EventListener<Key = K, Value = V>>, ) -> Self

Set event listener.

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

Build in-memory cache with the given configuration.