Struct MerkleTree

Source
pub struct MerkleTree<T> {
    pub algorithm: Sha3,
    /* private fields */
}
Expand description

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: Sha3

The hashing algorithm used by this Merkle tree

Implementations§

Source§

impl<T> MerkleTree<T>

Source

pub fn from_vec<H>(algorithm: Sha3, values: Vec<T>) -> Self
where T: Hashable, Sha3: HashUtils<H>, H: AsRef<[u8]>,

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

Source

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

Returns the root hash of Merkle tree

Source

pub fn height(&self) -> usize

Returns the height of Merkle tree

Source

pub fn count(&self) -> usize

Returns the number of leaves in the Merkle tree

Source

pub fn is_empty(&self) -> bool

Returns whether the Merkle tree is empty or not

Source

pub fn gen_proof<H>(&self, value: T) -> Option<Proof<T>>
where T: Hashable, Sha3: HashUtils<H>, H: AsRef<[u8]>,

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

Source

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

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

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

fn into_iter(self) -> Self::IntoIter

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

Source§

type Item = &'a T

The type of the elements being iterated over.
Source§

type IntoIter = LeavesIterator<'a, T>

Which kind of iterator are we turning this into?
Source§

impl<T> IntoIterator for MerkleTree<T>

Source§

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.

Source§

type Item = T

The type of the elements being iterated over.
Source§

type IntoIter = LeavesIntoIterator<T>

Which kind of iterator are we turning this into?

Auto Trait Implementations§

§

impl<T> Freeze for MerkleTree<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for MerkleTree<T>
where T: RefUnwindSafe,

§

impl<T> Send for MerkleTree<T>
where T: Send,

§

impl<T> Sync for MerkleTree<T>
where T: Sync,

§

impl<T> Unpin for MerkleTree<T>
where T: Unpin,

§

impl<T> UnwindSafe for MerkleTree<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.