Struct dusk_merkle::Tree

pub struct Tree<T, const H: usize, const A: usize> { /* private fields */ }

A sparse Merkle tree.

Implementations

impl<T, const H: usize, const A: usize> Tree<T, H, A>where T: Aggregate<A>,

pub const fn new() -> Self

Create a new merkle tree with the given initial root.

pub fn insert(&mut self, position: u64, item: impl Into<T>)

Insert an item at the given position in the tree.

Panics

If position >= capacity.

pub fn remove(&mut self, position: u64) -> Option<T>

Remove and return the item at the given position in the tree if it exists.

pub fn opening(&self, position: u64) -> Option<Opening<T, H, A>>where T: Clone,

Returns the Opening for the given position if it exists.

pub fn walk<W>(&self, walker: W) -> Walk<'_, T, W, H, A> where W: Fn(&T) -> bool,

Returns a Walk through the tree, proceeding according to the walker function.

A walk starts from the root of the tree, and “drills down” according to the output of the walker function. The function should return true or false, indicating whether the iterator should continue along the tree’s path.

pub fn root(&self) -> Ref<'_, T>

Get the root of the merkle tree.

pub fn smallest_subtree(&self) -> (Ref<'_, T>, usize)

Returns the root of the smallest sub-tree that holds all the leaves.

pub fn contains(&self, position: u64) -> bool

Returns true if the tree contains a leaf at the given position.

pub fn len(&self) -> u64

Returns the number of elements that have been inserted into the tree.

pub fn is_empty(&self) -> bool

Returns true if the tree is empty.

pub const fn capacity(&self) -> u64

The maximum number of leaves in the tree, i.e. its capacity.

Trait Implementations

impl<T: Clone, const H: usize, const A: usize> Clone for Tree<T, H, A>

fn clone(&self) -> Tree<T, H, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const H: usize, const A: usize> Debug for Tree<T, H, A>

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

Formats the value using the given formatter.

impl<T: PartialEq, const H: usize, const A: usize> PartialEq for Tree<T, H, A>

fn eq(&self, other: &Tree<T, H, A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Eq, const H: usize, const A: usize> Eq for Tree<T, H, A>

impl<T, const H: usize, const A: usize> StructuralEq for Tree<T, H, A>

impl<T, const H: usize, const A: usize> StructuralPartialEq for Tree<T, H, A>