Struct merkle::Proof

pub struct Proof<T> {
    pub algorithm: &'static Algorithm,
    pub root_hash: Vec<u8>,
    pub lemma: Lemma,
    pub value: T,
}

An inclusion proof represent the fact that a value is a member of a MerkleTree with root hash root_hash, and hash function algorithm.

Fields

algorithm: &'static Algorithm

The hashing algorithm used in the original MerkleTree

root_hash: Vec<u8>

The hash of the root of the original MerkleTree

lemma: Lemma

The first Lemma of the Proof

value: T

The value concerned by this Proof

Methods

impl<T> Proof<T>

pub fn new(
    algorithm: &'static Algorithm,
    root_hash: Vec<u8>,
    lemma: Lemma,
    value: T
) -> Self

Constructs a new Proof

pub fn validate(&self, root_hash: &[u8]) -> bool

Checks whether this inclusion proof is well-formed, and whether its root hash matches the given root_hash.

pub fn index(&self, count: usize) -> usize

Returns the index of this proof's value, given the total number of items in the tree.

Panics

Panics if the proof is malformed. Call validate first.

Trait Implementations

impl<T: Clone> Clone for Proof<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Ord> Ord for Proof<T>

fn cmp(&self, other: &Proof<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: Ord> PartialOrd<Proof<T>> for Proof<T>

fn partial_cmp(&self, other: &Proof<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<Proof<T>> for Proof<T>

fn eq(&self, other: &Proof<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 Proof<T>

impl<T: Debug> Debug for Proof<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Proof<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].