Struct miden_processor::utils::collections::RecordingMap

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

A RecordingMap that records read requests to the underlying key-value map.

The data recorder is used to generate a proof for read requests.

The RecordingMap is composed of three parts:

• data: which contains the current set of key-value pairs in the map.
• updates: which tracks keys for which values have been changed since the map was instantiated. updates include both insertions, removals and updates of values under existing keys.
• trace: which contains the key-value pairs from the original data which have been accesses since the map was instantiated.

Implementations

impl<K, V> RecordingMap<K, V>

where K: Ord + Clone, V: Clone,

pub fn new(init: impl IntoIterator<Item = (K, V)>) -> RecordingMap<K, V>

Returns a new RecordingMap instance initialized with the provided key-value pairs. (BTreeMap).

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

pub fn finalize(self) -> (BTreeMap<K, V>, BTreeMap<K, V>)

Consumes the RecordingMap and returns a (BTreeMap, BTreeMap) tuple. The first element of the tuple is a map that represents the state of the map at the time .finalize() is called. The second element contains the key-value pairs from the initial data set that were read during recording.

Trait Implementations

impl<K, V> Clone for RecordingMap<K, V>

where K: Clone, V: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V> Debug for RecordingMap<K, V>

where K: Debug, V: Debug,

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

Formats the value using the given formatter.

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

where K: Default, V: Default,

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

Returns the “default value” for a type.

impl<K, V> Extend<(K, V)> for RecordingMap<K, V>

where K: Clone + Ord, V: Clone,

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = (K, V)>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

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

where K: Clone + Ord, V: Clone,

fn from_iter<T>(iter: T) -> RecordingMap<K, V>

where T: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.

impl<K, V> IntoIterator for RecordingMap<K, V>

where K: Clone + Ord, V: Clone,

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <RecordingMap<K, V> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<K, V> KvMap<K, V> for RecordingMap<K, V>

where K: Ord + Clone, V: Clone,

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

Returns a reference to the value associated with the given key if the value exists.

If the key is part of the initial data set, the key access is recorded.

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

Returns a boolean to indicate whether the given key exists in the data set.

If the key is part of the initial data set, the key access is recorded.

fn len(&self) -> usize

Returns the number of key-value pairs in the data set.

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

Inserts a key-value pair into the data set.

If the key already exists in the data set, the value is updated and the old value is returned.

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

Removes a key-value pair from the data set.

If the key exists in the data set, the old value is returned.

fn iter(&self) -> Box<dyn Iterator<Item = (&K, &V)> + '_>

Returns an iterator over the key-value pairs in the data set.

fn is_empty(&self) -> bool

impl<K, V> PartialEq for RecordingMap<K, V>

where K: PartialEq, V: PartialEq,

fn eq(&self, other: &RecordingMap<K, V>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K, V> Eq for RecordingMap<K, V>

where K: Eq, V: Eq,

impl<K, V> StructuralPartialEq for RecordingMap<K, V>