Struct SetAssociativeCache 

pub struct SetAssociativeCache<E: KeyExtract, S: BuildHasher, L: CacheLayout, A: Allocator = Global> {
    pub metrics: Metrics,
    /* private fields */
}

A set-associative cache with CLOCK eviction, SIMD tag matching, and custom allocator support.

Fields

metrics: Metrics

Cache hit/miss metrics.

Implementations

impl<E: KeyExtract, S: BuildHasher + Default, L: CacheLayout> SetAssociativeCache<E, S, L>

where E::Key: Hash + Eq,

pub fn new(value_count_max: u64) -> Self

Create a new cache with default hasher and global allocator.

impl<E: KeyExtract, S: BuildHasher, L: CacheLayout> SetAssociativeCache<E, S, L>

where E::Key: Hash + Eq,

pub fn with_hasher(value_count_max: u64, hash_builder: S) -> Self

Create a new cache with the given hasher and global allocator.

impl<E: KeyExtract, S: BuildHasher, L: CacheLayout, A: Allocator> SetAssociativeCache<E, S, L, A>

where E::Key: Hash + Eq,

pub fn with_hasher_and_alloc( value_count_max: u64, hash_builder: S, alloc: A, ) -> Self

Create a new cache with the given hasher and allocator.

pub fn value_count_max_multiple() -> u64

Minimum alignment multiple that value_count_max must satisfy.

pub fn reset(&mut self)

Reset the cache, clearing all entries and metrics.

pub fn get_index<Q>(&mut self, key: &Q) -> Option<usize>

where Q: Hash + Equivalent<E::Key> + ?Sized,

Look up a key, returning its index if found.

pub fn get<Q>(&mut self, key: &Q) -> Option<&E::Value>

where Q: Hash + Equivalent<E::Key> + ?Sized,

Look up a key, returning a reference to the value if found.

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut E::Value>

where Q: Hash + Equivalent<E::Key> + ?Sized,

Look up a key, returning a mutable reference to the value if found.

pub fn remove<Q>(&mut self, key: &Q) -> Option<E::Value>

where Q: Hash + Equivalent<E::Key> + ?Sized,

Remove a key from the cache if present.

pub fn demote<Q>(&mut self, key: &Q)

where Q: Hash + Equivalent<E::Key> + ?Sized,

Hint that the key is less likely to be accessed in the future.

pub fn upsert(&mut self, value: E::Value) -> UpsertResult<E::Value>

Upsert a value, evicting an older entry if needed.

Trait Implementations

impl<E: KeyExtract, S: BuildHasher, L: CacheLayout, A: Allocator> Drop for SetAssociativeCache<E, S, L, A>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.