Struct moka::policy::EvictionPolicy

source ·
pub struct EvictionPolicy { /* private fields */ }
Expand description

The eviction (and admission) policy of a cache.

When the cache is full, the eviction/admission policy is used to determine which items should be admitted to the cache and which cached items should be evicted. The choice of a policy will directly affect the performance (hit rate) of the cache.

The following policies are available:

  • TinyLFU (default):
    • Suitable for most workloads.
    • TinyLFU combines the LRU eviction policy and an admission policy based on the historical popularity of keys.
    • Note that it tracks not only the keys currently in the cache, but all hit and missed keys. The data structure used to estimate the popularity of keys is a modified Count-Min Sketch, which has a very low memory footprint (thus the name “tiny”).
  • LRU:
    • Suitable for some workloads with strong recency bias, such as streaming data processing.

LFU stands for Least Frequently Used. LRU stands for Least Recently Used.

Use associate function EvictionPolicy::tiny_lfu or EvictionPolicy::lru to obtain an instance of EvictionPolicy.

Implementations§

source§

impl EvictionPolicy

source

pub fn tiny_lfu() -> Self

Returns the TinyLFU policy, which is suitable for most workloads.

TinyLFU is a combination of the LRU eviction policy and the admission policy based on the historical popularity of keys.

Note that it tracks not only the keys currently in the cache, but all hit and missed keys. The data structure used to estimate the popularity of keys is a modified Count-Min Sketch, which has a very low memory footprint (thus the name “tiny”).

source

pub fn lru() -> Self

Returns the LRU policy.

Suitable for some workloads with strong recency bias, such as streaming data processing.

Trait Implementations§

source§

impl Clone for EvictionPolicy

source§

fn clone(&self) -> EvictionPolicy

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for EvictionPolicy

source§

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

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

impl Default for EvictionPolicy

source§

fn default() -> EvictionPolicy

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

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> 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> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

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>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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.