Struct Map

pub struct Map<K: 'static + Key, V: 'static + Value>(/* private fields */);

Multithreaded hash map that is always saved atomically

Calling clone() will create a reference to the same instance, and can be easily shared between threads.

For tracking incremental changes to your data structure, look at VersionedMap

Implementations

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

where K: Key, V: Value,

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

Insert a new value for the given key in the map.

pub fn update_with<Q, R>( &self, key: &Q, fun: impl FnOnce(&K, &mut Arc<V>) -> R, ) -> Option<R>

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

Update a value with the given key, and return the new value if the key exists.

pub fn insert_with(&self, key: K, fun: impl FnMut() -> V) -> Arc<V>

Call the given function to insert a value if it doesn’t exist. Return with the current value to the key.

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

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

Returns the stored value for a key, or None.

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

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

Sets the key as removed in the map.

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

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

Returns if there’s an addition for the specified key.

pub fn for_each(&self, callback: impl FnMut(&K, &Arc<V>))

Call the function for all additive keys.

pub fn len(&self) -> usize

Returns the number of keys.

pub fn capacity(&self) -> usize

Return the size of all allocated items.

pub fn is_empty(&self) -> bool

True if the map doesn’t contain any items.

Trait Implementations

impl<K: Clone + 'static + Key, V: Clone + 'static + Value> Clone for Map<K, V>

fn clone(&self) -> Map<K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Default + 'static + Key, V: Default + 'static + Value> Default for Map<K, V>

fn default() -> Map<K, V>

Returns the “default value” for a type.

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

where K: Key + Clone, V: Value + Clone,

fn store_all(&self) -> Result<Vec<Intent<Box<dyn Store>>>>

Generate an Intent wrapper for each field in the Index.

fn load_all(&self) -> Result<Vec<Intent<Box<dyn Load>>>>

Generate an Intent wrapper for each field in the Index.