Struct associative_cache::replacement::lru::WithLruTimestamp

pub struct WithLruTimestamp<T> { /* fields omitted */ }

A wrapper around a T cache value that maintains a timestamp for use with LRU cache replacement policies.

Provides Deref[Mut] and As{Ref,Mut} implementations, so it is easy to drop in with minimal source changes.

You can recover ownership of the inner T value via WithLruTimestamp::into_inner(x) once a value has been removed from the cache.

Example

use associative_cache::*;

let cache = AssociativeCache::<
    String,
    // Wrap your cache value in `WithLruTimestamp`...
    WithLruTimestamp<usize>,
    Capacity128,
    HashEightWay,
    // ... and take advantage of LRU cache replacement!
    LruReplacement,
>::default();

Methods

impl<T> WithLruTimestamp<T>

pub fn new(inner: T) -> WithLruTimestamp<T>

Construct a new WithLruTimestamp wrapper around an inner value.

Example

use associative_cache::*;

let inner = "hello!".to_string();
let outer = WithLruTimestamp::new(inner);

pub fn into_inner(outer: WithLruTimestamp<T>) -> T

Recover the inner T value by consuming a WithLruTimestamp<T>.

Example

use associative_cache::*;

let outer = WithLruTimestamp::new("hello!".to_string());
let inner = WithLruTimestamp::into_inner(outer);
assert_eq!(inner, "hello!");

Trait Implementations

impl<T> LruTimestamp for WithLruTimestamp<T>

type Timestamp = Cell<Instant>

The timestamp type that will be compared.

fn get_timestamp(&self) -> &Self::Timestamp

Get this cache value's timestamp.

fn update_timestamp(&self)

Update this cache value's timestamp.

impl<T> From<T> for WithLruTimestamp<T>

fn from(inner: T) -> WithLruTimestamp<T>

Performs the conversion.

impl<T> AsMut<T> for WithLruTimestamp<T>

fn as_mut(&mut self) -> &mut T

Performs the conversion.

impl<T: Clone> Clone for WithLruTimestamp<T>

fn clone(&self) -> WithLruTimestamp<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Default for WithLruTimestamp<T> where
    T: Default, 

fn default() -> Self

Returns the "default value" for a type.

impl<T: PartialOrd> PartialOrd<WithLruTimestamp<T>> for WithLruTimestamp<T>

fn partial_cmp(&self, other: &WithLruTimestamp<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &WithLruTimestamp<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &WithLruTimestamp<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &WithLruTimestamp<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &WithLruTimestamp<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> AsRef<T> for WithLruTimestamp<T>

fn as_ref(&self) -> &T

Performs the conversion.

impl<T: Eq> Eq for WithLruTimestamp<T>

impl<T: Ord> Ord for WithLruTimestamp<T>

fn cmp(&self, other: &WithLruTimestamp<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<WithLruTimestamp<T>> for WithLruTimestamp<T>

fn eq(&self, other: &WithLruTimestamp<T>) -> bool

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

fn ne(&self, other: &WithLruTimestamp<T>) -> bool

This method tests for !=.

impl<T> Deref for WithLruTimestamp<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for WithLruTimestamp<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: Debug> Debug for WithLruTimestamp<T>

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

Formats the value using the given formatter.