Struct darkfi_sdk::dark_tree::DarkForest

pub struct DarkForest<T: Clone + Send + Sync> {
    trees: Vec<DarkTree<T>>,
    min_capacity: Option<usize>,
    max_capacity: Option<usize>,
}

This struct represents a Forest of DarkTree. It is advised to always execute .build() after finishing setting up the Forest, to properly index it and check its integrity.

Fields

trees: Vec<DarkTree<T>>

Vector containing all forest’s trees

min_capacity: Option<usize>

Optional min capacity of the forest, including all tree leafs. If tree leafs make us not exceed that min capacity, we will be able to catch it using .check_min_capacity() or .integrity_check().

max_capacity: Option<usize>

Optional max capacity of the forest, including all tree leafs. None indicates no capacity restrictions. If tree leafs make us exceed that capacity, we will be able to catch it using .check_max_capacity() or .integrity_check().

Implementations

impl<T: Clone + Send + Sync> DarkForest<T>

pub fn new( min_capacity: Option<usize>, max_capacity: Option<usize>, ) -> DarkForest<T>

Initialize a DarkTree, using provided data to generate its root.

pub fn build(&mut self) -> DarkTreeResult<()>

Build each individual DarkTree indexes and be used after we have appended all trees, so we don’t have to call .index() and .integrity_check() manually.

pub fn build_vec(&mut self) -> DarkTreeResult<Vec<DarkLeaf<T>>>

Build each individual DarkTree using .build() and then produce a flattened vector containing, all the leafs in DFS post-order traversal order, updating their indexes to correspond to the tree position in the forest.

fn len(&self) -> usize

Return the count of all DarkForest leafs.

fn check_min_capacity(&self) -> DarkTreeResult<()>

Check if configured min capacity have not been exceeded.

fn check_max_capacity(&self) -> DarkTreeResult<()>

Check if configured max capacity have been exceeded.

pub fn append(&mut self, tree: DarkTree<T>) -> DarkTreeResult<()>

Append a new DarkTree to the DarkForest, if max capacity has not been exceeded. This call doesn’t update the indexes, so either .index() or .build() must be called after it.

fn index(&mut self)

Setup each individual DarkTree’s leafs indexes.

fn integrity_check(&self) -> DarkTreeResult<()>

Verify each individual DarkTree’s leafs indexes validity, based on DFS post-order traversal order. Additionally, check that min and max capacities have been properly configured, min capacity has been exceeded and max capacity has not.

Trait Implementations

impl<T: Debug + Clone + Send + Sync> Debug for DarkForest<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + Clone + Send + Sync> PartialEq for DarkForest<T>

fn eq(&self, other: &DarkForest<T>) -> 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: Clone + Send + Sync> StructuralPartialEq for DarkForest<T>