Struct TrackingDict 

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

A HashMap wrapper that records which keys have been mutated.

Implementations

impl<K, V> TrackingDict<K, V>

where K: Eq + Hash + Clone,

pub fn new() -> Self

Create an empty TrackingDict.

pub fn from_map(data: HashMap<K, V>) -> Self

Create a TrackingDict pre-populated with data. None of the initial keys are considered dirty.

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

Returns a reference to the value for the given key, if present.

pub fn contains_key(&self, key: &K) -> bool

Returns true if the map contains the key.

pub fn len(&self) -> usize

Returns the number of entries.

pub fn is_empty(&self) -> bool

Returns true if the map is empty.

pub fn iter(&self) -> impl Iterator<Item = (&K, &V)>

Iterate over all (key, value) pairs. Not tracked.

pub fn inner(&self) -> &HashMap<K, V>

Returns a reference to the underlying HashMap. Not tracked.

pub fn insert(&mut self, key: K, value: V) -> Option<V>

Insert a key-value pair. Marks key as dirty.

pub fn remove(&mut self, key: &K) -> Option<V>

Remove a key. Marks key as dirty if it was present.

pub fn clear(&mut self)

Clear all entries. Marks every existing key as dirty.

pub fn set_default(&mut self, key: K, default: V) -> &mut V

where V: Clone,

Like HashMap::entry, but marks the key as dirty on any insertion.

pub fn update_no_track(&mut self, other: HashMap<K, V>)

Merge entries from other without marking any key as dirty. Equivalent to Python’s update_no_track.

pub fn mark_as_accessed(&mut self, key: K)

Manually mark a key as dirty so it appears in the next drain.

pub fn pop_accessed_keys(&mut self) -> HashSet<K>

Drain and return all keys that have been written to since the last call to this method (or since construction).

pub fn pop_accessed_write_items(&mut self) -> Vec<(K, EntryValue<V>)>

where V: Clone,

Drain dirty keys together with their current values. If a key was deleted, the value is EntryValue::Deleted.

Trait Implementations

impl<K: Clone, V: Clone> Clone for TrackingDict<K, V>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug> Debug for TrackingDict<K, V>

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

Formats the value using the given formatter.

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

where K: Eq + Hash + Clone,

fn default() -> Self

Returns the “default value” for a type.

impl<K, V> FromIterator<(K, V)> for TrackingDict<K, V>

where K: Eq + Hash + Clone,

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

Creates a value from an iterator.