Struct RootHash 

pub struct RootHash<H: Digest> { /* private fields */ }

The root hash of a Merkle tree. This uniquely represents the tree.

Implementations

impl<H: Digest> RootHash<H>

pub fn verify_consistency( &self, old_root: &RootHash<H>, proof: &ConsistencyProof<H>, ) -> Result<(), ConsistencyVerifError>

Verifies a proof that the tree described by old_root is a prefix of the tree described by self. This does not panic.

Note

Verification success does NOT imply that the size of the tree that produced the proof equals self.num_leaves(), or that the old tree size was old_root.num_leaves(). For any given proof, there are multiple tree size combinations that could have produced it.

impl<H: Digest> RootHash<H>

pub fn verify_inclusion<T: HashableLeaf>( &self, val: &T, idx: u64, proof: &InclusionProof<H>, ) -> Result<(), InclusionVerifError>

Verifies that val occurs at index idx in the tree described by this RootHash. This does not panic.

Note

Verification success does NOT imply that the size of the tree that produced the proof equals self.num_leaves(). For any given proof, there are multiple tree sizes that could have produced it.

impl<H: Digest> RootHash<H>

pub fn new(digest: Output<H>, num_leaves: u64) -> RootHash<H>

Constructs a RootHash from the given hash digest and the number of leaves in the tree that created it.

pub fn as_bytes(&self) -> &Output<H>

Returns the Merkle Tree Hash of the tree that created this RootHash.

This is precisely the Merkle Tree Hash (MTH) of the tree that created it, as defined in RFC 6962 §2.1.

pub fn num_leaves(&self) -> u64

Returns the number of leaves in the tree that created this RootHash.

Trait Implementations

impl<H: Clone + Digest> Clone for RootHash<H>

fn clone(&self) -> RootHash<H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H: Debug + Digest> Debug for RootHash<H>

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

Formats the value using the given formatter.

impl<H: Digest> PartialEq for RootHash<H>

fn eq(&self, other: &RootHash<H>) -> bool

Compares this RootHash to another in constant time.

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<H: Digest> Eq for RootHash<H>