Struct sharded::map::Map

pub struct Map<K, V, S = RandomState> { /* fields omitted */ }

Sharded, lock-based hash map using the crate default lock

Implementations

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

pub fn with_capacity(capacity: usize) -> Self where
    K: Debug,
    V: Debug, 

Create a new map with the provided capacity. This will distribute the capacity evenly among all the shards (well.. see below)

pub fn with_capacity_and_hasher(
    capacity: usize,
    hash_builder: RandomState
) -> Self where
    K: Debug,
    V: Debug, 

Create a new map with the provided capacity and hash_builder. This will distribute the capacity evenly among all the shards (well.. see below)

pub fn read<'a>(
    &'a self,
    key: &'a K
) -> (ReadKey<'a, K>, RwLockReadGuard<'a, Shard<K, V>>) where
    K: Hash + Eq, 

Get a read guard to the shard corresponding to the provided key

Panics if the shard lock is poisoned

pub fn try_read<'a>(
    &'a self,
    key: &'a K
) -> Result<(ReadKey<'a, K>, RwLockReadGuard<'a, Shard<K, V>>), WouldBlock> where
    K: Hash + Eq, 

Attempt to retrieve a read guard for the shard corresponding to the provided key. If a writer currently holds the lock, this will return an Err(WouldBlock)

Panics if the shard lock is poisoned

pub fn contains<'a>(&'a self, key: &'a K) -> bool where
    K: Eq + Hash, 

Does the map contain the provided key

pub fn len(&self) -> usize

Number of elements in the map

pub fn get_owned<'a>(&'a self, key: &'a K) -> Option<V> where
    K: Eq + Hash,
    V: Clone, 

Returns a cloned value corresponding to the provided key

pub fn write<'a>(
    &'a self,
    key: K
) -> (WriteKey<K>, RwLockWriteGuard<'a, Shard<K, V>>) where
    K: Hash + Eq, 

Get a read guard to the shard corresponding to the provided key

Panics if the shard lock is poisoned

pub fn insert(&self, k: K, v: V) -> Option<V> where
    K: Hash + Eq, 

Insert a key value pair into the Map. Returns the existing value at the provided key if there was one.

pub fn remove(&self, k: K) -> Option<V> where
    K: Hash + Eq, 

Remove using the provided key. Returns the existing value, if any.

pub fn new() -> Map<K, V> where
    K: Debug,
    V: Debug, 

Create an empty sharded map

pub fn into_iter(self) -> IntoIter<K, V>

Creates a consuming iterator, that is, one that moves each key-value pair out of the map in arbitrary order. The map cannot be used after calling this.

pub fn into_values(self) -> IntoValues<K, V>

Creates a consuming iterator, that is, one that moves each key-value pair out of the map in arbitrary order. The map cannot be used after calling this. Yields the values of the map.