Enum caches::PutResult

pub enum PutResult<K, V> {
    Put,
    Update(V),
    Evicted {
        key: K,
        value: V,
    },
    EvictedAndUpdate {
        evicted: (K, V),
        update: V,
    },
}

PutResult is returned when try to put a entry in cache.

• PutResult::Put means that the key is not in cache previously, and the cache has enough capacity, no evict happens.

• PutResult::Update means that the key already exists in the cache, and this operation updates the key’s value and the inner is the old value.

• PutResult::Evicted means that the the key is not in cache previously, but the cache is full, so the evict happens. The inner is the evicted entry (Key, Value).

• PutResult::EvictedAndUpdate is only possible to be returned by TwoQueueCache and AdaptiveCache. For more information, please see the related examples of TwoQueueCache and AdaptiveCache

Variants

Put

Put means that the key is not in cache previously, and the cache has enough capacity, no evict happens.

Update(V)

Update means that the key already exists in the cache, and this operation updates the key’s value and the inner is the old value

Evicted

Fields

key: K

The key for the evicted entry.

value: V

The value for the evicted entry.

Evicted means that the the key is not in cache previously, but the cache is full, so the evict happens. The inner is the evicted entry (Key, Value).

EvictedAndUpdate

Fields

evicted: (K, V)

The evicted entry.

update: V

The old value for the updated entry.

EvictedAndUpdate is only possible to be returned by TwoQueueCache.

For more information, please see the related examples of TwoQueueCache.

Trait Implementations

impl<K: Clone, V: Clone> Clone for PutResult<K, V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug> Debug for PutResult<K, V>

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

Formats the value using the given formatter.

impl<K: PartialEq, V: PartialEq> PartialEq<PutResult<K, V>> for PutResult<K, V>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K: Copy, V: Copy> Copy for PutResult<K, V>

impl<K: Eq, V: Eq> Eq for PutResult<K, V>