Struct FlatTree 

pub struct FlatTree<'a, T> { /* private fields */ }

Representation of a flat tree of element type T where the 'a is the life-time parameter of the underlying FlatStore.

At the moment the tree is append only, i.e. it can add new leave elements but not update or deletion.

Implementations

impl<'a, T: Merkleable> FlatTree<'a, T>

pub fn new(store: &'a dyn FlatStore<T>, size: u64) -> Self

Return a FlatTree object of given size with the underlying FlatStore as storage. If a non-zero size is given, it assumes a valid tree has been previously created on the same store.

pub fn depth(&self) -> usize

Depth of a full tree.

pub fn width(&self) -> u64

Width of the tree (number of leave nodes).

pub fn is_empty(&self) -> bool

Return true if tree is empty.

pub fn len(&self) -> u64

Number of leaves in the tree (same as width).

pub fn push(&mut self, value: T)

Append a leaf value to the tree.

pub fn append(&mut self, value: Vec<T>)

Append a number of leaf values to the tree.

pub fn get(&self, leaf_index: u64) -> Option<T>

Return the value at a given leaf index if it exists.

pub fn iter(&self) -> Box<dyn Iterator<Item = T> + '_>

Iterate over all leaf values.

pub fn root(&self) -> T

Return the top root of the full tree.

pub fn local_path(&self, i: u64) -> LocalPathIterator<'_, T>

Return the merkle path iterating from the leaf at the given index to one of the local roots.

pub fn full_path(&self, i: u64) -> FullPathIterator<'_, T>

Return the merkle path iterating from the leaf at the given index to top root.

pub fn full_path_from_node_index(&self, i: u64) -> FullPathIterator<'_, T>

where T: Clone,

Return the full path iterating from the given node index (either leaf or branch node) to top root. Note that for leaf nodes, node_index = leaf_index * 2.