Struct bridgetree::NonEmptyFrontier

pub struct NonEmptyFrontier<H> { /* private fields */ }

A NonEmptyFrontier is a reduced representation of a Merkle tree, containing a single leaf value, along with the vector of hashes produced by the reduction of previously appended leaf values that will be required when producing a witness for the current leaf.

Implementations

impl<H> NonEmptyFrontier<H>

pub fn new(leaf: H) -> NonEmptyFrontier<H>

Constructs a new frontier with the specified value at position 0.

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

Constructs a new frontier from its constituent parts.

pub fn into_parts(self) -> (Position, H, Vec<H, Global>)

Decomposes the frontier into its constituent parts

pub fn position(&self) -> Position

Returns the position of the most recently appended leaf.

pub fn leaf(&self) -> &H

Returns the leaf most recently appended to the frontier.

pub fn ommers(&self) -> &[H]

Returns the list of past hashes required to construct a witness for the leaf most recently appended to the frontier.

impl<H> NonEmptyFrontier<H>where H: Hashable + Clone,

pub fn append(&mut self, leaf: H)

Append a new leaf to the frontier, and recompute ommers by hashing together full subtrees until an empty ommer slot is found.

pub fn root(&self, root_level: Option<Level>) -> H

Generate the root of the Merkle tree by hashing against empty subtree roots.

pub fn witness<F>( &self, depth: u8, complement_nodes: F ) -> Result<Vec<H, Global>, Address>where F: Fn(Address) -> Option<H>,

Constructs a witness for 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.

Trait Implementations

impl<H> Clone for NonEmptyFrontier<H>where H: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H> Debug for NonEmptyFrontier<H>where H: Debug,

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

Formats the value using the given formatter.

impl<H> PartialEq<NonEmptyFrontier<H>> for NonEmptyFrontier<H>where H: PartialEq<H>,

fn eq(&self, other: &NonEmptyFrontier<H>) -> 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<Frontier<H, DEPTH>, FrontierError>

Performs the conversion.

impl<H> Eq for NonEmptyFrontier<H>where H: Eq,

impl<H> StructuralEq for NonEmptyFrontier<H>

impl<H> StructuralPartialEq for NonEmptyFrontier<H>