Struct incrementalmerkletree::frontier::Frontier

pub struct Frontier<H, const DEPTH: u8> { /* private fields */ }

A possibly-empty Merkle frontier.

Implementations

impl<H, const DEPTH: u8> Frontier<H, DEPTH>

pub fn empty() -> Self

Constructs a new empty frontier.

pub fn from_parts( position: Position, leaf: H, ommers: Vec<H> ) -> Result<Self, FrontierError>

Constructs a new frontier from its constituent parts.

Returns an error if the new frontier would exceed the maximum allowed depth or if the list of ommers provided is not consistent with the position of the leaf.

pub fn value(&self) -> Option<&NonEmptyFrontier<H>>

Return the wrapped NonEmptyFrontier reference, or None if the frontier is empty.

pub fn take(self) -> Option<NonEmptyFrontier<H>>

Consumes this wrapper and returns the underlying Option<NonEmptyFrontier>

pub fn dynamic_memory_usage(&self) -> usize

Returns the amount of memory dynamically allocated for ommer values within the frontier.

pub fn tree_size(&self) -> u64

Returns the size of the Merkle tree that this frontier corresponds to.

impl<H: Hashable + Clone, const DEPTH: u8> Frontier<H, DEPTH>

pub fn append(&mut self, value: H) -> bool

Appends a new value to the frontier at the next available slot. Returns true if successful and false if the frontier would exceed the maximum allowed depth.

pub fn root(&self) -> H

Obtains the current root of this Merkle frontier by hashing against empty nodes up to the maximum height of the pruned tree that the frontier represents.

pub fn witness<F>( &self, complement_nodes: F ) -> Result<Option<MerklePath<H, DEPTH>>, Address>

where F: Fn(Address) -> Option<H>,

Constructs a MerklePath to the leaf at the tip of this frontier, given a source of node values that complement this frontier.

If the complement_nodes function returns None when the value is requested at a given tree address, the address at which the failure occurs will be returned as an error.

Returns Ok(Some(MerklePath)) if successful, Ok(None) if the frontier is empty, or an error containing the address of the failure.

impl<H: Hashable + Clone, const DEPTH: u8> Frontier<H, DEPTH>

where Standard: Distribution<H>,

pub fn random_of_size<R: RngCore>(rng: &mut R, tree_size: u64) -> Self

Generates a random frontier of a Merkle tree having the specified size.

pub fn random_with_prior_subtree_roots<R: RngCore>( rng: &mut R, tree_size: u64, subtree_depth: NonZeroU8 ) -> (Vec<H>, Self)

Trait Implementations

impl<H: Clone, const DEPTH: u8> Clone for Frontier<H, DEPTH>

fn clone(&self) -> Frontier<H, DEPTH>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Debug, const DEPTH: u8> Debug for Frontier<H, DEPTH>

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

Formats the value using the given formatter.

impl<H: Hashable + Clone, const DEPTH: u8> Frontier<H> for Frontier<H, DEPTH>

fn append(&mut self, value: H) -> bool

Available on crate feature test-dependencies only.

Appends a new value to the frontier at the next available slot. Returns true if successful and false if the frontier would exceed the maximum allowed depth.

fn root(&self) -> H

Available on crate feature test-dependencies only.

Obtains the current root of this Merkle frontier by hashing against empty nodes up to the maximum height of the pruned tree that the frontier represents.

impl<H: PartialEq, const DEPTH: u8> PartialEq for Frontier<H, DEPTH>

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<H, const DEPTH: u8> TryFrom<NonEmptyFrontier<H>> for Frontier<H, DEPTH>

type Error = FrontierError

The type returned in the event of a conversion error.

fn try_from(f: NonEmptyFrontier<H>) -> Result<Self, FrontierError>

Performs the conversion.

impl<H: Eq, const DEPTH: u8> Eq for Frontier<H, DEPTH>

impl<H, const DEPTH: u8> StructuralPartialEq for Frontier<H, DEPTH>