Module darkfi_sdk::dark_tree

DarkTree structures

Structs

• DarkForest
  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.
• DarkLeaf
  This struct represents the information hold by a DarkTreeLeaf, namely its data, along with positional indexes information, based on tree’s traversal order. These indexes are only here to enable referencing connected nodes, and are not used as pointers by the tree. Creator must ensure they are properly setup.
• DarkTree
  This struct represents a Tree using DFS post-order traversal, where when we iterate through the tree, we first process tree node’s children, and then the node itself, recursively. Based on this, initial tree node (leaf), known as the root, will always show up at the end of iteration. It is advised to always execute .build() after finishing setting up the Tree, to properly index it and check its integrity.
• DarkTreeIntoIter
  Special iterator of a DarkTree, performing DFS post-order traversal on the Tree leafs, consuming each leaf. Since this iterator consumes the tree, it becomes unusable after it’s moved.
• DarkTreeIter
  Immutable iterator of a DarkTree, performing DFS post-order traversal on the Tree leafs.
• DarkTreeIterMut
  Mutable iterator of a DarkTree, performing DFS post-order traversal on the Tree leafs.
• DarkTreeLeaf
  This struct represents a Leaf of a DarkTree, holding this tree node data, along with its positional index, based on tree’s traversal order.

Functions

• check_children 🔒
  Check DarkLeaf children indexes validity
• dark_forest_leaf_vec_integrity_check
  Auxiliary function to verify provided DarkLeaf slice, representing the leafs of a DarkForest, is properly bounded and its members indexes are valid. Slice must contain at least 1 leaf.
• dark_leaf_vec_integrity_check
  Auxiliary function to verify provided DarkLeaf slice is properly bounded and its members indexes are valid. Optionally, an offset can be provided in case leaf indexes are known to be shifted.