Struct CacheBuilder

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

In-memory cache builder.

Implementations

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

where K: Key, V: Value,

pub fn new(capacity: usize) -> Self

Create a new in-memory cache builder.

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

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

pub fn with_name(self, name: impl Into<Cow<'static, 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_hash_builder<OS>( self, hash_builder: OS, ) -> CacheBuilder<K, V, OS, M>

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 with_metrics_registry<OM>( self, registry: OM, ) -> CacheBuilder<K, V, S, OM>

where OM: RegistryOps,

Set metrics registry.

Default: NoopMetricsRegistry.

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

where M: RegistryOps,

Build in-memory cache with the given configuration.