Struct incrementalmerkletree::testing::complete_tree::CompleteTree

pub struct CompleteTree<H, C: Ord, const DEPTH: u8> { /* private fields */ }

Available on crate feature test-dependencies only.

Implementations

impl<H: Hashable, C: Clone + Ord + Debug, const DEPTH: u8> CompleteTree<H, C, DEPTH>

pub fn new(max_checkpoints: usize) -> Self

Creates a new, empty binary tree

Trait Implementations

impl<H: Clone, C: Clone + Ord, const DEPTH: u8> Clone for CompleteTree<H, C, DEPTH>

fn clone(&self) -> CompleteTree<H, C, DEPTH>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Debug, C: Debug + Ord, const DEPTH: u8> Debug for CompleteTree<H, C, DEPTH>

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

Formats the value using the given formatter.

impl<H: Hashable + PartialEq + Clone, C: Ord + Clone + Debug, const DEPTH: u8> Tree<H, C> for CompleteTree<H, C, DEPTH>

fn depth(&self) -> u8

Returns the depth of the tree.

fn append(&mut self, value: H, retention: Retention<C>) -> bool

Appends a new value to the tree at the next available slot. Returns true if successful and false if the tree would exceed the maximum allowed depth.

fn current_position(&self) -> Option<Position>

Returns the most recently appended leaf value.

fn marked_positions(&self) -> BTreeSet<Position>

Return a set of all the positions for which we have marked.

fn get_marked_leaf(&self, position: Position) -> Option<H>

Returns the leaf at the specified position if the tree can produce a witness for it.

fn root(&self, checkpoint_depth: usize) -> Option<H>

Obtains the root of the Merkle tree at the specified checkpoint depth by hashing against empty nodes up to the maximum height of the tree. Returns None if there are not enough checkpoints available to reach the requested checkpoint depth.

fn witness(&self, position: Position, checkpoint_depth: usize) -> Option<Vec<H>>

Obtains a witness for the value at the specified leaf position, as of the tree state at the given checkpoint depth. Returns None if there is no witness information for the requested position or if no checkpoint is available at the specified depth.

fn remove_mark(&mut self, position: Position) -> bool

Marks the value at the specified position as a value we’re no longer interested in maintaining a mark for. Returns true if successful and false if we were already not maintaining a mark at this position.

fn checkpoint(&mut self, id: C) -> bool

Creates a new checkpoint for the current tree state.

fn rewind(&mut self) -> bool

Rewinds the tree state to the previous checkpoint, and then removes that checkpoint record.