Skip to main content

MemoryStore

Struct MemoryStore 

Source
pub struct MemoryStore<V, K = String>
where K: Eq + Hash + Clone, V: Clone,
{ /* private fields */ }
Expand description

A thread-safe in-memory key-value store.

This store is designed to be WASM-compatible and can be used to cache any type of data that implements Clone. It uses interior mutability via RwLock to allow concurrent read access.

§Type Parameters

  • K: The key type, must implement Eq + Hash + Clone
  • V: The value type, must implement Clone

Implementations§

Source§

impl<V, K> MemoryStore<V, K>
where K: Eq + Hash + Clone, V: Clone,

Source

pub fn new(config: MemoryStoreConfig) -> Self

Create a new memory store with the given configuration.

Source

pub fn insert(&self, key: K, value: V)

Insert a value into the store.

If the store has a maximum entry limit and is at capacity, an arbitrary entry will be evicted to make room.

Source

pub fn get(&self, key: &K) -> Option<V>

Get a value from the store.

Returns Some(value) if the key exists, None otherwise.

Source

pub fn contains(&self, key: &K) -> bool

Check if a key exists in the store.

Source

pub fn remove(&self, key: &K) -> Option<V>

Remove a value from the store.

Returns the removed value if the key existed.

Source

pub fn clear(&self)

Clear all entries from the store.

Source

pub fn len(&self) -> usize

Get the number of entries in the store.

Source

pub fn is_empty(&self) -> bool

Check if the store is empty.

Source

pub fn keys(&self) -> Vec<K>

Get all keys in the store.

Source

pub fn stats(&self) -> MemoryStoreStats

Get statistics for the store.

Only meaningful if track_stats was enabled in the config.

Source

pub fn reset_stats(&self)

Reset statistics.

Source

pub fn get_or_insert_with<F>(&self, key: K, factory: F) -> V
where F: FnOnce() -> V,

Get or insert a value using a factory function.

If the key exists, returns the existing value. If the key doesn’t exist, calls the factory function to create a value, inserts it, and returns it.

Trait Implementations§

Source§

impl<V, K> Clone for MemoryStore<V, K>
where K: Eq + Hash + Clone, V: Clone,

Source§

fn clone(&self) -> Self

Returns a duplicate 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<V, K> Debug for MemoryStore<V, K>
where K: Eq + Hash + Clone + Debug, V: Clone + Debug,

Source§

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

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

impl<V> Default for MemoryStore<V, String>
where V: Clone,

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<V, K> Freeze for MemoryStore<V, K>

§

impl<V, K> RefUnwindSafe for MemoryStore<V, K>

§

impl<V, K> Send for MemoryStore<V, K>
where K: Send + Sync, V: Send + Sync,

§

impl<V, K> Sync for MemoryStore<V, K>
where K: Send + Sync, V: Send + Sync,

§

impl<V, K> Unpin for MemoryStore<V, K>

§

impl<V, K> UnsafeUnpin for MemoryStore<V, K>

§

impl<V, K> UnwindSafe for MemoryStore<V, K>

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