Struct BalanceTree 

pub struct BalanceTree<const P: u8 = 2> { /* private fields */ }

One (currency, layer) of a seal: accounts leaves, the non-zero ones kept.

use doubleentry::{AccountHandle, Balance, Layer, Side, amount, currency::EUR, log::BalanceTree};

let mut tree: BalanceTree = BalanceTree::new(EUR, Layer::Settled, 3);
let cash = Balance::ZERO.post(Side::Debit, amount!("1190.00"))?;
let sales = Balance::ZERO.post(Side::Credit, amount!("1190.00"))?;
tree.set(AccountHandle::new(0).unwrap(), cash)?;
tree.set(AccountHandle::new(2).unwrap(), sales)?;
assert_eq!(
    tree.root().to_string(),
    "61a2dffcc9633717adfac15db9f40c2f9390bfab45181a7e2dad078cf25451e8",
);

Implementations

impl<const P: u8> BalanceTree<P>

pub const fn new(currency: Currency, layer: Layer, accounts: u32) -> Self

An all-zero tree of accounts leaves.

pub fn set( &mut self, handle: AccountHandle, balance: Balance<P>, ) -> Result<(), ProofError>

Sets a handle’s balance; a zero balance removes it.

Errors

ProofError::IndexOutOfRange for a handle not below accounts.

pub const fn currency(&self) -> Currency

The currency.

pub const fn layer(&self) -> Layer

The layer.

pub const fn accounts(&self) -> u32

The number of leaves.

pub fn root(&self) -> Hash

The RFC 6962 root over all accounts leaves.

pub fn totals(&self) -> Result<Balance<P>, AmountError>

The component-wise sum of every leaf.

Errors

AmountError::Overflow when a total leaves its range.

pub fn head(&self) -> Result<TreeHeadEntry<P>, AmountError>

The seal entry for this tree: currency, layer, root and totals.

Errors

As totals.

pub fn prove( &self, handle: AccountHandle, ) -> Result<BalanceProof<P>, ProofError>

The proof of one handle’s balance (the zero leaf for an account without postings).

Errors

ProofError::IndexOutOfRange for a handle not below accounts.

Trait Implementations

impl<const P: u8> Clone for BalanceTree<P>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const P: u8> Debug for BalanceTree<P>

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

Formats the value using the given formatter.

impl<const P: u8> Eq for BalanceTree<P>

impl<const P: u8> PartialEq for BalanceTree<P>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.