Struct RcuHashMap 

pub struct RcuHashMap<K, V, S = RapidBuildHasher>
where
    K: Eq + Hash + Clone + Send + Sync + 'static,
    V: Clone + Send + Sync + 'static,
    S: BuildHasher + Send + Sync + 'static,
{ /* private fields */ }

A concurrent hash map that uses RCU for read synchronization and a mutex for write synchronization.

This map allows concurrent readers to access entries without blocking, while writers are synchronized via a Mutex.

By default, this map uses rapidhash::RapidBuildHasher, which provides high performance. However, if this map holds keys which may be attacker-controlled, consider using std::collections::hash_map::RandomState instead.

Implementations

impl<K, V, S> RcuHashMap<K, V, S>

where K: Eq + Hash + Clone + Send + Sync + 'static, V: Clone + Send + Sync + 'static, S: BuildHasher + Send + Sync + 'static,

pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self

Creates a new hash map with the given capacity and hasher.

pub fn with_hasher(hash_builder: S) -> Self

Creates a new hash map with the given hasher.

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

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

Returns a reference to the value associated with the given key, if it exists.

The returned reference is bound to the lifetime of the RcuReadScope.

pub fn lock(&self) -> RcuHashMapGuard<'_, K, V, S>

Locks the map for exclusive access, returning a guard that allows mutation.

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

Inserts a key-value pair into the map, returning the old value if the key was already present.

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

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

Removes a key from the map, returning the value if the key was present.

pub fn iter<'a>( &'a self, scope: &'a RcuReadScope, ) -> impl Iterator<Item = (&'a K, &'a V)>

Returns an iterator over the map’s entries.

pub fn keys<'a>( &'a self, scope: &'a RcuReadScope, ) -> impl Iterator<Item = &'a K>

Returns an iterator over the map’s keys.

Trait Implementations

impl<K, V, S> Debug for RcuHashMap<K, V, S>

where K: Eq + Hash + Debug + Clone + Send + Sync + 'static, V: Debug + Clone + Send + Sync + 'static, S: BuildHasher + Send + Sync + 'static,

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

Formats the value using the given formatter.

impl<K, V> Default for RcuHashMap<K, V, RapidBuildHasher>

where K: Eq + Hash + Clone + Send + Sync + 'static, V: Clone + Send + Sync + 'static,

fn default() -> Self

Returns the “default value” for a type.