Skip to main content

InMemoryCache

Struct InMemoryCache 

Source
pub struct InMemoryCache<K, V, H = RandomState>
where K: Hash + Eq + Send + Sync + 'static, V: Clone + Send + Sync + 'static, H: BuildHasher + Clone + Send + Sync + 'static,
{ /* private fields */ }
Available on crate features memory only.
Expand description

A concurrent in-memory cache tier.

This cache provides:

  • Concurrent access with high performance
  • Automatic eviction based on capacity
  • Thread-safe operations

§Examples

use cachet_memory::InMemoryCache;
use cachet_tier::{CacheEntry, CacheTier};


let cache = InMemoryCache::<String, i32>::new();

cache
    .insert("key".to_string(), CacheEntry::new(42))
    .await
    .unwrap();
let value = cache.get(&"key".to_string()).await.unwrap();
assert_eq!(*value.unwrap().value(), 42);

Implementations§

Source§

impl<K, V> InMemoryCache<K, V>
where K: Hash + Eq + Send + Sync + 'static, V: Clone + Send + Sync + 'static,

Source

pub fn new() -> InMemoryCache<K, V>

Creates a new unbounded in-memory cache.

The cache will use default eviction policy (TinyLFU).

§Examples
use cachet_memory::InMemoryCache;

let cache = InMemoryCache::<String, i32>::new();
Source

pub fn with_max_capacity(max_capacity: u64) -> InMemoryCache<K, V>

Creates a new in-memory cache with a maximum capacity.

Once the capacity is reached, entries will be evicted using the TinyLFU policy (combination of LRU eviction and LFU admission).

§Examples
use cachet_memory::InMemoryCache;

let cache = InMemoryCache::<String, i32>::with_max_capacity(1000);
Source

pub fn builder() -> InMemoryCacheBuilder<K, V>

Creates a new builder for configuring an in-memory cache.

The builder provides access to additional configuration options such as time-to-live, time-to-idle, and initial capacity.

§Examples
use std::time::Duration;

use cachet_memory::InMemoryCache;

let cache = InMemoryCache::<String, i32>::builder()
    .max_capacity(1000)
    .time_to_live(Duration::from_secs(300))
    .time_to_idle(Duration::from_secs(60))
    .build();

Trait Implementations§

Source§

impl<K, V, H> CacheTier<K, V> for InMemoryCache<K, V, H>
where K: Clone + Hash + Eq + Send + Sync + 'static, V: Clone + Send + Sync + 'static, H: BuildHasher + Clone + Send + Sync + 'static,

Source§

async fn get(&self, key: &K) -> Result<Option<CacheEntry<V>>, Error>

Gets a value, returning an error if the operation fails.
Source§

async fn insert(&self, key: K, entry: CacheEntry<V>) -> Result<(), Error>

Inserts or replaces a value, returning an error if the operation fails. Read more
Source§

async fn invalidate(&self, key: &K) -> Result<(), Error>

Invalidates a value, returning an error if the operation fails.
Source§

async fn clear(&self) -> Result<(), Error>

Clears all entries, returning an error if the operation fails.
Source§

async fn len(&self) -> Result<u64, SizeError>

Returns an approximate count of entries, if the implementation supports it. Read more
Source§

fn is_empty(&self) -> impl Future<Output = Result<bool, SizeError>> + Send

Returns Ok(true) if the cache appears to contain no entries. Read more
Source§

impl<K, V, H> Clone for InMemoryCache<K, V, H>
where K: Clone + Hash + Eq + Send + Sync + 'static, V: Clone + Send + Sync + 'static, H: Clone + BuildHasher + Send + Sync + 'static,

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<K, V, H> Debug for InMemoryCache<K, V, H>
where K: Debug + Hash + Eq + Send + Sync + 'static, V: Debug + Clone + Send + Sync + 'static, H: Debug + BuildHasher + Clone + Send + Sync + 'static,

Source§

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

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

impl<K, V> Default for InMemoryCache<K, V>
where K: Hash + Eq + Send + Sync + 'static, V: Clone + Send + Sync + 'static,

Source§

fn default() -> InMemoryCache<K, V>

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

impl<K, V, H> ThreadAware for InMemoryCache<K, V, H>
where K: ThreadAware + Hash + Eq + Send + Sync + 'static, V: ThreadAware + Clone + Send + Sync + 'static, H: ThreadAware + BuildHasher + Clone + Send + Sync + 'static,

Source§

fn relocate(&mut self, source: Option<Affinity>, destination: Affinity)

Relocate this value in place to the destination affinity. Read more

Auto Trait Implementations§

§

impl<K, V, H = RandomState> !RefUnwindSafe for InMemoryCache<K, V, H>

§

impl<K, V, H = RandomState> !UnwindSafe for InMemoryCache<K, V, H>

§

impl<K, V, H> Freeze for InMemoryCache<K, V, H>

§

impl<K, V, H> Send for InMemoryCache<K, V, H>

§

impl<K, V, H> Sync for InMemoryCache<K, V, H>

§

impl<K, V, H> Unpin for InMemoryCache<K, V, H>

§

impl<K, V, H> UnsafeUnpin for InMemoryCache<K, V, H>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

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<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.
Source§

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

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

Source§

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

Source§

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