Struct ic_certified_map::RbTree

pub struct RbTree<K: 'static + AsRef<[u8]>, V: AsHashTree + 'static> { /* fields omitted */ }

Implements mutable Leaf-leaning red-black trees as defined in https://www.cs.princeton.edu/~rs/talks/LLRB/LLRB.pdf

Implementations

impl<K: 'static + AsRef<[u8]>, V: AsHashTree + 'static> RbTree<K, V>

pub fn new() -> Self

pub fn is_empty(&self) -> bool

pub fn get(&self, key: &[u8]) -> Option<&V>

pub fn modify(&mut self, key: &[u8], f: impl FnOnce(&mut V))

Updates the value corresponding to the specified key.

pub fn witness<'a>(&'a self, key: &[u8]) -> HashTree<'a>

Constructs a hash tree that acts as a proof that there is a entry with the specified key in this map. The proof also contains the value in question.

If the key is not in the map, returns a proof of absence.

pub fn nested_witness<'a>(
    &'a self,
    key: &[u8],
    f: impl FnOnce(&'a V) -> HashTree<'a>
) -> HashTree<'a>

Like witness, but gives the caller more control over the construction of the value witness. This method is useful for constructing witnesses for nested certified maps.

pub fn keys(&self) -> HashTree<'_>

Returns a witness enumerating all the keys in this map. The resulting tree doesn’t include values, they are replaced with “Pruned” nodes.

pub fn key_range(&self, first: &[u8], last: &[u8]) -> HashTree<'_>

Returns a witness for the keys in the specified range. The resulting tree doesn’t include values, they are replaced with “Pruned” nodes.

pub fn value_range(&self, first: &[u8], last: &[u8]) -> HashTree<'_>

Returns a witness for the key-value pairs in the specified range. The resulting tree contains both keys and values.

pub fn keys_with_prefix(&self, prefix: &[u8]) -> HashTree<'_>

Returns a witness that enumerates all the keys starting with the specified prefix.

pub fn for_each<'a, F>(&'a self, f: F) where
    F: 'a + FnMut(&'a [u8], &'a V), 

Enumerates all the key-value pairs in the tree.

pub fn insert(&mut self, key: K, value: V)

Inserts a key-value entry into the map.

pub fn delete(&mut self, key: &[u8])

Removes the specified key from the map.

Trait Implementations

impl<K: 'static + AsRef<[u8]>, V: AsHashTree + 'static> AsHashTree for RbTree<K, V>

fn root_hash(&self) -> Hash

Returns the root hash of the tree without constructing it. Must be equivalent to as_hash_tree().reconstruct().

fn as_hash_tree(&self) -> HashTree<'_>

Constructs a hash tree corresponding to the data.

impl<K: 'static + AsRef<[u8]>, V: AsHashTree + 'static> Default for RbTree<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<K: 'static + AsRef<[u8]>, V: AsHashTree + 'static> Drop for RbTree<K, V>

fn drop(&mut self)

Executes the destructor for this type.