Struct starling::merkle_bit::MerkleBIT

pub struct MerkleBIT<DatabaseType, BranchType, LeafType, DataType, NodeType, HasherType, ValueType, ArrayType> where
    DatabaseType: Database<ArrayType, NodeType = NodeType>,
    BranchType: Branch<ArrayType>,
    LeafType: Leaf<ArrayType>,
    DataType: Data,
    NodeType: Node<BranchType, LeafType, DataType, ArrayType>,
    HasherType: Hasher<ArrayType>,
    ArrayType: Array,
    ValueType: Decode + Encode,  { /* fields omitted */ }

The MerkleBIT structure relies on many specified types:

Required Type Annotations

• DatabaseType: The type to use for database-like operations. DatabaseType must implement the Database trait.
• BranchType: The type used for representing branches in the tree. BranchType must implement the Branch trait.
• LeafType: The type used for representing leaves in the tree. LeafType must implement the Leaf trait.
• DataType: The type used for representing data nodes in the tree. DataType must implement the Data trait.
• NodeType: The type used for the outer node that can be either a branch, leaf, or data. NodeType must implement the Node trait.
• HasherType: The type of hasher to use for hashing locations on the tree. HasherType must implement the Hasher trait.
• ValueType: The type to return from a get. ValueType must implement the Encode and Decode traits.
• ArrayType: The type that stores the keys and hash results. ArrayType must implement the Array trait.

Properties

• db: The database to store and retrieve values.
• depth: The maximum permitted depth of the tree.

Implementations

impl<DatabaseType, BranchType, LeafType, DataType, NodeType, HasherType, ValueType, ArrayType> MerkleBIT<DatabaseType, BranchType, LeafType, DataType, NodeType, HasherType, ValueType, ArrayType> where
    DatabaseType: Database<ArrayType, NodeType = NodeType>,
    BranchType: Branch<ArrayType>,
    LeafType: Leaf<ArrayType>,
    DataType: Data,
    NodeType: Node<BranchType, LeafType, DataType, ArrayType>,
    HasherType: Hasher<ArrayType, HashType = HasherType>,
    ValueType: Decode + Encode,
    ArrayType: Array, 

pub fn new(path: &PathBuf, depth: usize) -> BinaryMerkleTreeResult<Self>

Create a new MerkleBIT from a saved database

Errors

Exception generated if the open fails.

pub fn from_db(db: DatabaseType, depth: usize) -> BinaryMerkleTreeResult<Self>

Create a new MerkleBIT from an already opened database

Errors

None.

pub fn get(
    &self,
    root_hash: &ArrayType,
    keys: &mut [ArrayType]
) -> BinaryMerkleTreeResult<HashMap<ArrayType, Option<ValueType>>>

Get items from the MerkleBIT. Returns a map of Options which may include the corresponding values.

Errors

Exception generated when an invalid state is encountered during tree traversal.

pub fn insert(
    &mut self,
    previous_root: Option<&ArrayType>,
    keys: &mut [ArrayType],
    values: &[ValueType]
) -> BinaryMerkleTreeResult<ArrayType>

Insert items into the MerkleBIT. Keys must be sorted. Returns a new root hash for the MerkleBIT.

Errors

Exception generated if an invalid state is encountered during tree traversal.

pub fn remove(&mut self, root_hash: &ArrayType) -> BinaryMerkleTreeResult<()>

Remove all items with less than 1 reference under the given root.

Errors

Exception generated when an invalid state is encountered during tree traversal.

pub fn generate_inclusion_proof(
    &self,
    root: &ArrayType,
    key: ArrayType
) -> BinaryMerkleTreeResult<Vec<(ArrayType, bool)>>

Generates an inclusion proof. The proof consists of a list of hashes beginning with the key/value pair and traveling up the tree until the level below the root is reached.

Errors

Exception generated when an invalid state is encountered during tree traversal.

pub fn verify_inclusion_proof(
    root: &ArrayType,
    key: ArrayType,
    value: &ValueType,
    proof: &[(ArrayType, bool)]
) -> BinaryMerkleTreeResult<()>

Verifies an inclusion proof.

Errors

Exception generated when the given proof is invalid.

pub fn get_one(
    &self,
    root: &ArrayType,
    key: &ArrayType
) -> BinaryMerkleTreeResult<Option<ValueType>>

Gets a single key from the tree.

Errors

Exception generated from encountering an invalid state during tree traversal.

pub fn insert_one(
    &mut self,
    previous_root: Option<&ArrayType>,
    key: &ArrayType,
    value: &ValueType
) -> BinaryMerkleTreeResult<ArrayType>

Inserts a single value into a tree.

Errors

Exception generated if an invalid state is encountered during tree traversal.