Struct MerkleTree

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

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

Implementations

impl<T> MerkleTree<T>

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

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.

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

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

Trait Implementations

impl<T> Clone for MerkleTree<T>

where T: Clone,

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> Debug for MerkleTree<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Hash for MerkleTree<T>

where T: Hash,

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

fn into_iter(self) -> <&'a MerkleTree<T> as IntoIterator>::IntoIter

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

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?

impl<T> IntoIterator for MerkleTree<T>

fn into_iter(self) -> <MerkleTree<T> as IntoIterator>::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.

type Item = T

The type of the elements being iterated over.

type IntoIter = LeavesIntoIterator<T>

Which kind of iterator are we turning this into?

impl<T> Ord for MerkleTree<T>

where T: Ord,

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for MerkleTree<T>

where T: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd for MerkleTree<T>

where T: Ord,

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<T> Eq for MerkleTree<T>

where T: Eq,