Struct cached::ExpiringValueCache

source · [−]

pub struct ExpiringValueCache<K: Hash + Eq, V: CanExpire> { /* private fields */ }

Expand description

Expiring Value Cache

Stores values that implement the CanExpire trait so that expiration is determined by the values themselves. This is useful for caching values which themselves contain an expiry timestamp.

Note: This cache is in-memory only.

Implementations

source

impl<K: Clone + Hash + Eq, V: CanExpire> ExpiringValueCache<K, V>

source

pub fn with_size(size: usize) -> ExpiringValueCache<K, V>

Creates a new ExpiringValueCache with a given size limit and pre-allocated backing data.

Trait Implementations

source

impl<K: Hash + Eq + Clone, V: CanExpire> Cached<K, V> for ExpiringValueCache<K, V>

source

fn cache_get(&mut self, k: &K) -> Option<&V>

Attempt to retrieve a cached value

source

fn cache_get_mut(&mut self, k: &K) -> Option<&mut V>

Attempt to retrieve a cached value with mutable access

source

fn cache_get_or_set_with<F: FnOnce() -> V>(&mut self, k: K, f: F) -> &mut V

Get or insert a key, value pair

source

fn cache_set(&mut self, k: K, v: V) -> Option<V>

Insert a key, value pair and return the previous value

source

fn cache_remove(&mut self, k: &K) -> Option<V>

Remove a cached value

source

fn cache_clear(&mut self)

Remove all cached values. Keeps the allocated memory for reuse.

source

fn cache_reset(&mut self)

Remove all cached values. Free memory and return to initial state

source

fn cache_size(&self) -> usize

Return the current cache size (number of elements)

source

fn cache_hits(&self) -> Option<u64>

Return the number of times a cached value was successfully retrieved

source

fn cache_misses(&self) -> Option<u64>

Return the number of times a cached value was unable to be retrieved

source

fn cache_reset_metrics(&mut self)

Reset misses/hits counters

source

fn cache_capacity(&self) -> Option<usize>

Return the cache capacity

source

fn cache_lifespan(&self) -> Option<u64>

Return the lifespan of cached values (time to eviction)

source

fn cache_set_lifespan(&mut self, _seconds: u64) -> Option<u64>

Set the lifespan of cached values, returns the old value

source

impl<K: Clone + Hash + Eq, V: Clone + CanExpire> Clone for ExpiringValueCache<K, V>

source

fn clone(&self) -> ExpiringValueCache<K, V>

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<K: Debug + Hash + Eq, V: Debug + CanExpire> Debug for ExpiringValueCache<K, V>

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<K, V> RefUnwindSafe for ExpiringValueCache<K, V> where
K: RefUnwindSafe,
V: RefUnwindSafe,

impl<K, V> Send for ExpiringValueCache<K, V> where
K: Send,
V: Send,

impl<K, V> Sync for ExpiringValueCache<K, V> where
K: Sync,
V: Sync,

impl<K, V> Unpin for ExpiringValueCache<K, V> where
K: Unpin,
V: Unpin,

impl<K, V> UnwindSafe for ExpiringValueCache<K, V> where
K: UnwindSafe,
V: UnwindSafe,

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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> 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct cached::ExpiringValueCache

Implementations

impl<K: Clone + Hash + Eq, V: CanExpire> ExpiringValueCache<K, V>

pub fn with_size(size: usize) -> ExpiringValueCache<K, V>

Trait Implementations

impl<K: Hash + Eq + Clone, V: CanExpire> Cached<K, V> for ExpiringValueCache<K, V>

fn cache_get(&mut self, k: &K) -> Option<&V>

fn cache_get_mut(&mut self, k: &K) -> Option<&mut V>

fn cache_get_or_set_with<F: FnOnce() -> V>(&mut self, k: K, f: F) -> &mut V

fn cache_set(&mut self, k: K, v: V) -> Option<V>

fn cache_remove(&mut self, k: &K) -> Option<V>

fn cache_clear(&mut self)

fn cache_reset(&mut self)

fn cache_size(&self) -> usize

fn cache_hits(&self) -> Option<u64>

fn cache_misses(&self) -> Option<u64>

fn cache_reset_metrics(&mut self)

fn cache_capacity(&self) -> Option<usize>

fn cache_lifespan(&self) -> Option<u64>

fn cache_set_lifespan(&mut self, _seconds: u64) -> Option<u64>

impl<K: Clone + Hash + Eq, V: Clone + CanExpire> Clone for ExpiringValueCache<K, V>

fn clone(&self) -> ExpiringValueCache<K, V>

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

impl<K: Debug + Hash + Eq, V: Debug + CanExpire> Debug for ExpiringValueCache<K, V>

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

Auto Trait Implementations

impl<K, V> RefUnwindSafe for ExpiringValueCache<K, V> where K: RefUnwindSafe, V: RefUnwindSafe,

impl<K, V> Send for ExpiringValueCache<K, V> where K: Send, V: Send,

impl<K, V> Sync for ExpiringValueCache<K, V> where K: Sync, V: Sync,

impl<K, V> Unpin for ExpiringValueCache<K, V> where K: Unpin, V: Unpin,

impl<K, V> UnwindSafe for ExpiringValueCache<K, V> where K: UnwindSafe, V: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

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

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

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<K, V> RefUnwindSafe for ExpiringValueCache<K, V> where
K: RefUnwindSafe,
V: RefUnwindSafe,

impl<K, V> Send for ExpiringValueCache<K, V> where
K: Send,
V: Send,

impl<K, V> Sync for ExpiringValueCache<K, V> where
K: Sync,
V: Sync,

impl<K, V> Unpin for ExpiringValueCache<K, V> where
K: Unpin,
V: Unpin,

impl<K, V> UnwindSafe for ExpiringValueCache<K, V> where
K: UnwindSafe,
V: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,