Struct ShardMap 

pub struct ShardMap<K, V, const SHARDS: usize = DEFAULT_CACHE_SHARDS> { /* private fields */ }

Cloneable native Rust sharded map.

ShardMap<K, V> stores K and V directly. Keys must implement Hash and Eq, matching the ordinary Rust HashMap contract.

Implementations

impl<K, V, const SHARDS: usize> ShardMap<K, V, SHARDS>

pub fn new() -> Self

Creates an empty native typed map.

pub fn with_capacity(capacity: usize) -> Self

Creates an empty native typed map with an approximate total capacity.

pub fn with_options(options: ShardMapOptions) -> Self

Creates an empty native typed map with explicit options.

pub const fn shard_count(&self) -> usize

Returns the configured number of shards.

pub fn route_key<Q>(&self, key: &Q) -> EmbeddedKeyRoute

where Q: Hash + ?Sized,

Computes the route for a key.

pub const fn default_ttl_ms(&self) -> Option<u64>

Returns the default TTL applied by write APIs that do not pass an explicit TTL.

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

where K: Eq + Hash,

Inserts or replaces a value, returning the old value when present.

pub fn insert_with_ttl( &self, key: K, value: V, ttl_ms: Option<u64>, ) -> Option<V>

where K: Eq + Hash,

Inserts or replaces a value with an optional relative TTL, returning the old live value when present.

pub fn try_insert(&self, key: K, value: V) -> bool

where K: Eq + Hash,

Inserts only when the key is absent.

pub fn try_insert_with_ttl(&self, key: K, value: V, ttl_ms: Option<u64>) -> bool

where K: Eq + Hash,

Inserts only when the key is absent or expired, with an optional relative TTL.

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

where K: Borrow<Q> + Eq + Hash, Q: Eq + Hash + ?Sized, V: Clone,

Returns an owned clone of the value.

pub fn get_ref<Q>(&self, key: &Q) -> Option<ShardMapRef<'_, K, V>>

where K: Borrow<Q> + Eq + Hash, Q: Eq + Hash + ?Sized,

Returns a borrowed value guard.

pub fn contains_key<Q>(&self, key: &Q) -> bool

where K: Borrow<Q> + Eq + Hash, Q: Eq + Hash + ?Sized,

Returns true when the key is present.

pub fn exists<Q>(&self, key: &Q) -> bool

where K: Borrow<Q> + Eq + Hash, Q: Eq + Hash + ?Sized,

Returns true when the key is present.

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

where K: Borrow<Q> + Eq + Hash, Q: Eq + Hash + ?Sized,

Removes a key and returns its value when present.

pub fn delete<Q>(&self, key: &Q) -> bool

where K: Borrow<Q> + Eq + Hash, Q: Eq + Hash + ?Sized,

Removes a key without returning the value.

pub fn len(&self) -> usize

Returns the number of entries currently stored.

pub fn is_empty(&self) -> bool

Returns true when the map contains no entries.

pub fn visit_keys(&self, visitor: impl FnMut(&K) -> bool)

Visits keys without allocating a snapshot.

The visitor runs while each shard read lock is held. Keep callbacks lightweight, and return false to stop early.

pub fn visit_entries(&self, visitor: impl FnMut(&K, &V) -> bool)

Visits entries without allocating a snapshot.

The visitor runs while each shard read lock is held. Keep callbacks lightweight, and return false to stop early.

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

where K: Clone,

Returns a snapshot of keys.

pub fn entries(&self) -> Vec<(K, V)>

where K: Clone, V: Clone,

Returns a snapshot of entries.

Trait Implementations

impl<K, V, const SHARDS: usize> Clone for ShardMap<K, V, SHARDS>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K, V, const SHARDS: usize> Debug for ShardMap<K, V, SHARDS>

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

Formats the value using the given formatter.

impl<K, V, const SHARDS: usize> Default for ShardMap<K, V, SHARDS>

fn default() -> Self

Returns the “default value” for a type.