Struct merkle_sigs::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 ) -> Proof<T>

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.

impl<T> Proof<T>

pub fn from_protobuf(     algorithm: &'static Algorithm,     proto: ProofProto ) -> Option<Proof<T>> where     T: From<Vec<u8>>,

Constructs a Proof struct from its Protobuf representation.

pub fn into_protobuf(self) -> ProofProto where     T: Into<Vec<u8>>,

Encode this Proof to its Protobuf representation.

pub fn parse_from_bytes(     bytes: &[u8],     algorithm: &'static Algorithm ) -> Result<Option<Proof<T>>, ProtobufError> where     T: From<Vec<u8>>,

Parse a Proof from its Protobuf binary representation.

pub fn write_to_bytes(self) -> Result<Vec<u8>, ProtobufError> where     T: Into<Vec<u8>>,

Serialize this Proof with Protobuf.

Trait Implementations

impl<T> Eq for Proof<T> where     T: Eq,

impl<T> PartialEq<Proof<T>> for Proof<T> where     T: PartialEq<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> Clone for Proof<T> where     T: Clone,

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> PartialOrd<Proof<T>> for Proof<T> where     T: Ord,

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> Ord for Proof<T> where     T: Ord,

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.

impl<T> Hash for Proof<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,

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

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

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

Formats the value using the given formatter.