Struct NestedMemoryMap

pub struct NestedMemoryMap<M: Copy + Clone + PartialEq + Eq + Hash + Serialize + for<'de> Deserialize<'de> + Send + Sync, K: Clone + PartialEq + Eq + Serialize + for<'de> Deserialize<'de> + Send + Sync, V: Clone + PartialEq + Eq + Serialize + for<'de> Deserialize<'de> + Send + Sync> { /* private fields */ }

Trait Implementations

impl<M: Clone + Copy + Clone + PartialEq + Eq + Hash + Serialize + for<'de> Deserialize<'de> + Send + Sync, K: Clone + Clone + PartialEq + Eq + Serialize + for<'de> Deserialize<'de> + Send + Sync, V: Clone + Clone + PartialEq + Eq + Serialize + for<'de> Deserialize<'de> + Send + Sync> Clone for NestedMemoryMap<M, K, V>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Copy + Clone + PartialEq + Eq + Hash + Serialize + for<'de> Deserialize<'de> + Send + Sync, K: Clone + PartialEq + Eq + Serialize + for<'de> Deserialize<'de> + Send + Sync, V: Clone + PartialEq + Eq + Serialize + for<'de> Deserialize<'de> + Send + Sync> Default for NestedMemoryMap<M, K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<M: Copy + Clone + PartialEq + Eq + Hash + Serialize + for<'de> Deserialize<'de> + Send + Sync, K: Clone + PartialEq + Eq + Serialize + for<'de> Deserialize<'de> + Send + Sync, V: Clone + PartialEq + Eq + Serialize + for<'de> Deserialize<'de> + Send + Sync> FromIterator<(M, K, V)> for NestedMemoryMap<M, K, V>

fn from_iter<I: IntoIterator<Item = (M, K, V)>>(iter: I) -> Self

Initializes a new NestedMemoryMap from the given iterator.

impl<'a, M: 'a + Copy + Clone + PartialEq + Eq + Hash + Serialize + for<'de> Deserialize<'de> + Send + Sync, K: 'a + Clone + PartialEq + Eq + Serialize + for<'de> Deserialize<'de> + Send + Sync, V: 'a + Clone + PartialEq + Eq + Serialize + for<'de> Deserialize<'de> + Send + Sync> NestedMap<'a, M, K, V> for NestedMemoryMap<M, K, V>

fn insert(&self, map: M, key: K, value: V) -> Result<()>

Inserts the given map-key-value pair.

fn remove_map(&self, map: &M) -> Result<()>

Removes the given map.

fn remove_key(&self, map: &M, key: &K) -> Result<()>

Removes the key-value pair for the given map and key.

fn start_atomic(&self)

Begins an atomic operation. Any further calls to insert and remove will be queued without an actual write taking place until finish_atomic is called.

fn is_atomic_in_progress(&self) -> bool

Checks whether an atomic operation is currently in progress. This can be done to ensure that lower-level operations don’t start and finish their individual atomic write batch if they are already part of a larger one.

fn atomic_checkpoint(&self)

Saves the current list of pending operations, so that if atomic_rewind is called, we roll back all future operations, and return to the start of this checkpoint.

fn clear_latest_checkpoint(&self)

Removes the latest atomic checkpoint.

fn atomic_rewind(&self)

Removes all pending operations to the last atomic_checkpoint (or to start_atomic if no checkpoints have been created).

fn abort_atomic(&self)

Aborts the current atomic operation.

fn finish_atomic(&self) -> Result<()>

Finishes an atomic operation, performing all the queued writes.

impl<'a, M: 'a + Copy + Clone + PartialEq + Eq + Hash + Serialize + for<'de> Deserialize<'de> + Send + Sync, K: 'a + Clone + PartialEq + Eq + Serialize + for<'de> Deserialize<'de> + Send + Sync, V: 'a + Clone + PartialEq + Eq + Serialize + for<'de> Deserialize<'de> + Send + Sync> NestedMapRead<'a, M, K, V> for NestedMemoryMap<M, K, V>

fn len_map_confirmed(&self, map: &M) -> Result<usize>

Returns the number of confirmed entries in the map.

fn contains_key_confirmed(&self, map: &M, key: &K) -> Result<bool>

Returns true if the given key exists in the map.

fn contains_key_speculative(&self, map: &M, key: &K) -> Result<bool>

Returns true if the given key exists in the map. This method first checks the atomic batch, and if it does not exist, then checks the map.

fn get_map_confirmed(&'a self, map: &M) -> Result<Vec<(K, V)>>

Returns the confirmed key-value pairs for the given map, if it exists.

fn get_map_speculative(&'a self, map: &M) -> Result<Vec<(K, V)>>

Returns the speculative key-value pairs for the given map, if it exists.

fn get_value_confirmed(&'a self, map: &M, key: &K) -> Result<Option<Cow<'a, V>>>

Returns the value for the given key from the map, if it exists.

fn get_value_pending(&self, map: &M, key: &K) -> Option<Option<V>>

Returns the current value for the given key if it is scheduled to be inserted as part of an atomic batch.

If the key does not exist, returns None. If the key is removed in the batch, returns Some(None). If the key is inserted in the batch, returns Some(Some(value)).

fn iter_pending(&'a self) -> Self::PendingIterator

Returns an iterator visiting each map-key-value pair in the atomic batch.

fn iter_confirmed(&'a self) -> Self::Iterator

Returns an iterator visiting each confirmed map-key-value pair.

fn keys_confirmed(&'a self) -> Self::Keys

Returns an iterator over each confirmed key.

fn values_confirmed(&'a self) -> Self::Values

Returns an iterator over each confirmed value.

type Iterator = IntoIter<(Cow<'a, M>, Cow<'a, K>, Cow<'a, V>)>

type Keys = IntoIter<(Cow<'a, M>, Cow<'a, K>)>

type PendingIterator = Map<IntoIter<(M, Option<K>, Option<V>)>, fn(_: (M, Option<K>, Option<V>)) -> (Cow<'a, M>, Option<Cow<'a, K>>, Option<Cow<'a, V>>)>

type Values = Map<IntoValues<Vec<u8>, V>, fn(_: V) -> Cow<'a, V>>

fn is_empty_map_confirmed(&self, map: &M) -> Result<bool>

Checks whether there are any confirmed entries in the map.

fn get_value_speculative( &'a self, map: &M, key: &K, ) -> Result<Option<Cow<'a, V>>>

Returns the value for the given key from the atomic batch first, if it exists, or return from the map, otherwise.