Struct merkle::MerkleTree

pub struct MerkleTree<T> {
    pub algorithm: &'static Algorithm,
    // some fields omitted
}

A Merkle tree is a binary tree, with values of type T at the leafs, and where every internal node holds the hash of the concatenation of the hashes of its children nodes.

Fields

algorithm: &'static Algorithm

The hashing algorithm used by this Merkle tree

Methods

impl<T> MerkleTree<T>

pub fn from_vec(algorithm: &'static Algorithm, values: Vec<T>) -> Self where
    T: Hashable, 

Constructs a Merkle Tree from a vector of data blocks. Returns None if values is empty.

pub fn root_hash(&self) -> &Vec<u8>

Returns the root hash of Merkle tree

pub fn height(&self) -> usize

Returns the height of Merkle tree

pub fn count(&self) -> usize

Returns the number of leaves in the Merkle tree

pub fn is_empty(&self) -> bool

Returns whether the Merkle tree is empty or not

pub fn gen_proof(&self, value: T) -> Option<Proof<T>> where
    T: Hashable, 

Generate an inclusion proof for the given value. Returns None if the given value is not found in the tree.

pub fn gen_nth_proof(&self, n: usize) -> Option<Proof<T>> where
    T: Hashable + Clone, 

Generate an inclusion proof for the n-th leaf value.

Important traits for LeavesIterator<'a, T>

impl<'a, T> Iterator for LeavesIterator<'a, T> type Item = &'a T;

pub fn iter(&self) -> LeavesIterator<T>

Creates an Iterator over the values contained in this Merkle tree.

Trait Implementations

impl<T: Clone> Clone for MerkleTree<T>

fn clone(&self) -> MerkleTree<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Ord> Ord for MerkleTree<T>

fn cmp(&self, other: &MerkleTree<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T> IntoIterator for MerkleTree<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = LeavesIntoIterator<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates a consuming iterator, that is, one that moves each value out of the Merkle tree. The tree cannot be used after calling this.

impl<'a, T> IntoIterator for &'a MerkleTree<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = LeavesIterator<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates a borrowing Iterator over the values contained in this Merkle tree.

impl<T: Ord> PartialOrd<MerkleTree<T>> for MerkleTree<T>

fn partial_cmp(&self, other: &MerkleTree<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: PartialEq> PartialEq<MerkleTree<T>> for MerkleTree<T>

fn eq(&self, other: &MerkleTree<T>) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Eq> Eq for MerkleTree<T>

impl<T: Debug> Debug for MerkleTree<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for MerkleTree<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].