Struct StorageUpdates 

pub struct StorageUpdates { /* private fields */ }

Represents a collection of changes to be applied atomically to an SMT storage backend.

This struct is used to batch multiple updates (to leaves, subtrees, and the SMT root) ensuring that they are persisted together as a single, consistent transaction. It also tracks deltas for leaf and entry counts, allowing storage implementations to maintain these counts accurately.

Implementations

impl StorageUpdates

pub fn new(new_root: Word) -> StorageUpdates

Creates a new StorageUpdates with the specified root hash and default empty updates.

This constructor is ideal for incremental building where you’ll add updates one by one using the convenience methods like insert_leaf() and insert_subtree().

pub fn from_parts( leaf_updates: BTreeMap<u64, Option<SmtLeaf>>, subtree_updates: BTreeMap<NodeIndex, Option<Subtree>>, new_root: Word, leaf_count_delta: isize, entry_count_delta: isize, ) -> StorageUpdates

Creates a new StorageUpdates from pre-computed components.

This constructor is ideal for bulk operations where you already have the complete maps of updates and calculated deltas, such as when applying a batch of mutations.

pub fn insert_leaf(&mut self, index: u64, leaf: SmtLeaf)

Adds a leaf insertion/update to the batch.

pub fn remove_leaf(&mut self, index: u64)

Adds a leaf removal to the batch.

pub fn insert_subtree(&mut self, subtree: Subtree)

Adds a subtree insertion/update to the batch.

pub fn remove_subtree(&mut self, index: NodeIndex)

Adds a subtree removal to the batch.

pub fn is_empty(&self) -> bool

Returns true if this update batch contains no changes.

pub fn leaf_update_count(&self) -> usize

Returns the number of leaf updates in this batch.

pub fn subtree_update_count(&self) -> usize

Returns the number of subtree updates in this batch.

pub fn leaf_updates(&self) -> &BTreeMap<u64, Option<SmtLeaf>>

Returns a reference to the leaf updates map.

pub fn subtree_updates(&self) -> &BTreeMap<NodeIndex, Option<Subtree>>

Returns a reference to the subtree updates map.

pub fn new_root(&self) -> Word

Returns the new root hash.

pub fn leaf_count_delta(&self) -> isize

Returns the leaf count delta.

pub fn entry_count_delta(&self) -> isize

Returns the entry count delta.

pub fn set_leaf_count_delta(&mut self, delta: isize)

Sets the leaf count delta.

pub fn set_entry_count_delta(&mut self, delta: isize)

Sets the entry count delta.

pub fn adjust_leaf_count_delta(&mut self, adjustment: isize)

Adjusts the leaf count delta by the specified amount.

pub fn adjust_entry_count_delta(&mut self, adjustment: isize)

Adjusts the entry count delta by the specified amount.

pub fn into_leaf_updates(self) -> BTreeMap<u64, Option<SmtLeaf>>

Consumes this StorageUpdates and returns the leaf updates map.

pub fn into_subtree_updates(self) -> BTreeMap<NodeIndex, Option<Subtree>>

Consumes this StorageUpdates and returns the subtree updates map.

pub fn into_parts(self) -> StorageUpdateParts

Consumes this StorageUpdates and returns its owned parts as a StorageUpdateParts.

Trait Implementations

impl Clone for StorageUpdates

fn clone(&self) -> StorageUpdates

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageUpdates

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

Formats the value using the given formatter.

impl Default for StorageUpdates

fn default() -> StorageUpdates

Returns the “default value” for a type.