Struct network::application::storage::LockingHashMap

pub struct LockingHashMap<Key: Clone + Debug + Eq + Hash, Value: Clone + Debug> { /* fields omitted */ }

A generic locking hash map with ability to read before write consistency

Implementations

impl<Key, Value> LockingHashMap<Key, Value> where
    Key: Clone + Debug + Eq + Hash,
    Value: Clone + Debug, 

pub fn new() -> Self

pub fn read(&self, key: &Key) -> Option<Value>

Get a clone of the value

pub fn read_filtered<F: FnMut(&(&Key, &Value)) -> bool>(
    &self,
    filter: F
) -> HashMap<Key, Value>

Filtered read clone based on keys or values

pub fn keys(&self) -> Vec<Key>

All keys of the hash map

pub fn read_all(&self) -> HashMap<Key, Value>

Read a clone of the entire state

pub fn insert(&self, key: Key, new_value: Value)

Insert new entry

pub fn remove(&self, key: &Key)

Remove old entries

pub fn write<F: FnOnce(&mut Entry<'_, Key, Value>) -> Result<(), PeerError>>(
    &self,
    key: Key,
    modifier: F
) -> Result<(), PeerError>

Take in a function to modify the data, must handle concurrency control with the input function

pub fn write_lock(&self) -> RwLockWriteGuard<'_, HashMap<Key, Value>>

Get the underlying RwLock of the map. Usage is discouraged as it leads to the possiblity of leaving the lock held for a long period of time. However, not everything fits into the write model.

Trait Implementations

impl<Key: Debug + Clone + Eq + Hash, Value: Debug + Clone> Debug for LockingHashMap<Key, Value>

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

Formats the value using the given formatter.