Struct IndexedMerkleProof

pub struct IndexedMerkleProof { /* private fields */ }

A Merkle proof of the given chunk.

Implementations

impl IndexedMerkleProof

pub fn new<I>( leaves: I, index: u64, ) -> Result<IndexedMerkleProof, MerkleConstructionError>

where I: IntoIterator<Item = Digest>, I::IntoIter: ExactSizeIterator,

Attempts to construct a new instance.

pub fn index(&self) -> u64

Returns the index.

pub fn count(&self) -> u64

Returns the total count of chunks.

pub fn root_hash(&self) -> Digest

Returns the root hash of this proof (i.e. the index hashed with the Merkle root hash).

Note that with the once_cell feature enabled (generally done by enabling the std feature), the root hash is memoized, and hence calling this method is cheap after the first call. Without once_cell enabled, every call to this method calculates the root hash.

pub fn merkle_proof(&self) -> &[Digest]

Returns the full collection of hash digests of the proof.

pub fn verify(&self) -> Result<(), MerkleVerificationError>

Attempts to verify self.

Trait Implementations

impl Clone for IndexedMerkleProof

fn clone(&self) -> IndexedMerkleProof

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataSize for IndexedMerkleProof

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for IndexedMerkleProof

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexedMerkleProof

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromBytes for IndexedMerkleProof

fn from_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), Error>

Deserializes the slice into Self.

fn from_vec(bytes: Vec<u8>) -> Result<(Self, Vec<u8>), Error>

Deserializes the Vec<u8> into Self.

impl JsonSchema for IndexedMerkleProof

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for IndexedMerkleProof

fn eq(&self, other: &IndexedMerkleProof) -> 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 Serialize for IndexedMerkleProof

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToBytes for IndexedMerkleProof

fn to_bytes(&self) -> Result<Vec<u8>, Error>

Serializes &self to a Vec<u8>.

fn serialized_length(&self) -> usize

Returns the length of the Vec<u8> which would be returned from a successful call to to_bytes() or into_bytes(). The data is not actually serialized, so this call is relatively cheap.

fn into_bytes(self) -> Result<Vec<u8>, Error>

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), Error>

Writes &self into a mutable writer.

impl Eq for IndexedMerkleProof

impl StructuralPartialEq for IndexedMerkleProof