Struct RcuHashMap

pub struct RcuHashMap<K, V, F = RcuDefaultFlavor>(/* private fields */)
where
    K: Send + 'static,
    V: Send + 'static,
    F: RcuFlavor + 'static;

Defines a RCU lock-free hashmap.

This hashmap supports multiple concurrents readers and writers. It is guaranteed to never block on a call.

Limitations

Mutable References

Because there might always be readers borrowing a node’s data, it is impossible to get a mutable references to the data inside the stack. You should design the type stored in the stack with interior mutabillity that can be shared between threads.

Safety

It is safe to send an Arc<RcuHashMap<T>> to a non-registered RCU thread. A non-registered thread may drop an RcuHashMap<T> without calling any RCU primitives since lifetime rules prevent any other thread from accessing an RCU reference.

Implementations

impl<K, V, F> RcuHashMap<K, V, F>

where K: Send, V: Send, F: RcuFlavor,

pub fn new() -> Result<Arc<Self>>

Creates a new RCU hashmap.

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

where K: Send + Eq + Hash, V: Send, G: RcuGuard<Flavor = F>,

Inserts a key-value pair in the hashmap.

If the hashmap did not have this key present, None is returned.

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

where K: Eq + Hash, G: RcuGuard<Flavor = F>,

Returns true if the hashmap contains a value for the specified key.

pub fn get<'me, 'guard, G>( &'me self, key: &K, _guard: &'guard G, ) -> Option<&'guard V>

where K: Eq + Hash, G: RcuGuard<Flavor = F>, 'me: 'guard,

Returns a reference to the value corresponding to the key.

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

where K: Send + Eq + Hash, V: Send, G: RcuGuard<Flavor = F>,

Removes a key from the hashmap, returning the key-value pair if successful.

pub fn iter<'me, 'guard, G>( &'me self, guard: &'guard G, ) -> Iter<'guard, K, V, F>

where G: RcuGuard<Flavor = F>, 'me: 'guard,

Returns an iterator visiting all key-value pairs in arbitrary order.

Trait Implementations

impl<K, V, F> Drop for RcuHashMap<K, V, F>

where K: Send + 'static, V: Send + 'static, F: RcuFlavor + 'static,

fn drop(&mut self)

Executes the destructor for this type.