Struct HashTreeBuilder

pub struct HashTreeBuilder { /* private fields */ }

An incremental Blake3 hasher that also maintains an array representation of the full Blake3 tree, the generated array will be in the same stack ordering as Blake3.

The number is this tree are the index of each of these nodes in the array representation, and because of how Blake3 functions, the left subtree will always contain a power of 2 number of chunks.

                 
          8
         / \
        /   \
       6     7
      / \
     /   \
    /     \
   2       5
  / \     / \
 /   \   /   \
0     1 3     4

Implementations

impl HashTreeBuilder

pub fn new() -> Self

Create a new HashTreeBuilder with the default IV.

pub fn update(&mut self, input: &[u8])

Input some more bytes to this hasher, this function is always single-threaded use Self::update_rayon to achieve multi-threaded implementation with rayon.

Also for the best performance it is recommended that you feed full blocks to this function or at least powers of two.

pub fn update_rayon(&mut self, input: &[u8])

Just like update but runs the hasher using rayon for work-stealing and parallelism.

pub fn update_with_join<J: Join>(&mut self, input: &[u8])

pub fn finalize(self) -> HashTree

Return the result of this execution including the root hash and the tree.

pub fn get_block_hash(&self, block_counter: usize) -> Option<[u8; 32]>

Return the hash of the given block, returns None if we are not there yet.

Trait Implementations

impl Clone for HashTreeBuilder

fn clone(&self) -> HashTreeBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl From<IV> for HashTreeBuilder

fn from(value: IV) -> Self

Converts to this type from the input type.