Struct Map 

pub struct Map<K, V> { /* private fields */ }

A concurrent map, Map is like sync.Map in Golang.

• K must implement Eq + PartialEq + Hash.
• V must implement Eq + PartialEq + Clone.

Implementations

impl<K, V> Map<K, V>

where K: Eq + PartialEq + Hash, V: Eq + PartialEq + Clone,

pub fn new() -> Self

Create a new Map.

pub fn compare_and_delete(&self, k: K, v: V) -> bool

compare_and_delete deletes the key-value pair for the given key if the value is equal to the given value. returns true if the kv was already in. returns false if the kv was not in.

pub fn compare_and_swap(&self, k: K, old_v: V, new_v: V) -> bool

compare_and_swap sets the value for the given key if the value is equal to the given old value. returns true if the kv was already in. returns false if the kv was not in.

pub fn store(&self, k: K, v: V)

store sets the value for the given key.

pub fn load(&self, k: K) -> Option<V>

load returns the value stored in the map for a key, or none if no value is present.

pub fn get<F>(&self, k: K, f: F) -> bool

where F: FnMut(&V),

without clone: a little faster return true if the key is in the map, false otherwise.

pub fn delete(&self, k: K)

delete deletes the key-value pair for the given key.

pub fn load_and_delete(&self, k: K) -> Option<V>

load_and_delete deletes the key-value pair for the given key and returns the value

pub fn load_or_store(&self, k: K, v: V) -> V

load_or_store returns the existing value for the key if present. otherwise, it stores and returns the given value.

pub fn swap(&self, k: K, v: V) -> Option<V>

swap swaps the value for a key and returns the old value

pub fn range<F>(&self, f: F)

where F: FnMut(&K, &V) -> bool,

range calls f sequentially for each key and value present in the map. if f returns false, range stops the iteration.

Trait Implementations

impl<K, V> Default for Map<K, V>

where K: Eq + PartialEq + Hash, V: Eq + PartialEq + Clone,

fn default() -> Self

Returns the “default value” for a type.