Struct AccountBalance 

pub struct AccountBalance { /* private fields */ }

Balance information for a single account. The sum of this struct’s fields is the total balance of the wallet.

Implementations

impl AccountBalance

pub const ZERO: Self

The Balance value having zero values for all its fields.

pub fn sapling_balance(&self) -> &Balance

Returns the Balance of Sapling funds in the account.

pub fn with_sapling_balance_mut<A, E: From<BalanceError>>( &mut self, f: impl FnOnce(&mut Balance) -> Result<A, E>, ) -> Result<A, E>

Provides a mutable reference to the Balance of Sapling funds in the account to the specified callback, checking invariants after the callback’s action has been evaluated.

pub fn orchard_balance(&self) -> &Balance

Returns the Balance of Orchard funds in the account.

pub fn with_orchard_balance_mut<A, E: From<BalanceError>>( &mut self, f: impl FnOnce(&mut Balance) -> Result<A, E>, ) -> Result<A, E>

Provides a mutable reference to the Balance of Orchard funds in the account to the specified callback, checking invariants after the callback’s action has been evaluated.

pub fn ironwood_balance(&self) -> &Balance

Returns the Balance of Ironwood funds in the account.

pub fn with_ironwood_balance_mut<A, E: From<BalanceError>>( &mut self, f: impl FnOnce(&mut Balance) -> Result<A, E>, ) -> Result<A, E>

Provides a mutable reference to the Balance of Ironwood funds in the account to the specified callback, checking invariants after the callback’s action has been evaluated.

pub fn unshielded(&self) -> Zatoshis

👎Deprecated:

this function is deprecated. Please use AccountBalance::unshielded_regular_balance and AccountBalance::unshielded_coinbase_balance instead.

Returns the total value of unspent transparent transaction outputs belonging to the wallet.

pub fn unshielded_balance(&self) -> Balance

Returns the combined Balance of unshielded funds in the account, computed as the sum of the unshielded_regular_balance and the unshielded_coinbase_balance.

The spendable_value field of the returned Balance contains funds that may be spent in a shielding transaction: transparent funds that satisfy the wallet’s confirmation policy, including coinbase funds that have reached maturity. The value_pending_spendability field contains transparent funds that are not yet spendable: funds that do not yet have the number of confirmations required by the wallet’s confirmation policy, and coinbase funds that have not yet reached maturity. The change_pending_confirmation field is currently always zero, because this crate does not yet distinguish transparent change from other transparent value awaiting confirmation.

pub fn unshielded_regular_balance(&self) -> &Balance

Returns the Balance of regular (non-coinbase) transparent funds in the account.

Transparent outputs whose containing transaction’s index within its block is unknown are classified as regular (non-coinbase) funds, consistent with the treatment described for CoinbaseFilter.

pub fn with_unshielded_regular_balance_mut<A, E: From<BalanceError>>( &mut self, f: impl FnOnce(&mut Balance) -> Result<A, E>, ) -> Result<A, E>

Provides a mutable reference to the Balance of regular (non-coinbase) transparent funds in the account to the specified callback, checking invariants after the callback’s action has been evaluated.

pub fn unshielded_coinbase_balance(&self) -> &Balance

Returns the Balance of funds in coinbase transparent outputs belonging to the account.

Coinbase outputs may only be spent by shielding them, and only once they have reached coinbase maturity; immature coinbase funds are reported in the value_pending_spendability field of the returned Balance. Outputs whose containing transaction’s index within its block is unknown are conservatively classified as regular (non-coinbase) funds and do not contribute to this balance; see CoinbaseFilter.

pub fn with_unshielded_coinbase_balance_mut<A, E: From<BalanceError>>( &mut self, f: impl FnOnce(&mut Balance) -> Result<A, E>, ) -> Result<A, E>

Provides a mutable reference to the Balance of transparent coinbase funds in the account to the specified callback, checking invariants after the callback’s action has been evaluated.

pub fn total(&self) -> Zatoshis

Returns the total value of economically relevant notes and UTXOs belonging to the account.

pub fn spendable_value(&self) -> Zatoshis

Returns the total value of shielded (Sapling, Orchard, and Ironwood) funds that may immediately be spent.

pub fn locked_value(&self) -> Zatoshis

Returns the total value of notes and UTXOs that are locked, having been committed to an in-flight transaction proposal or PCZT.

pub fn change_pending_confirmation(&self) -> Zatoshis

Returns the total value of change and/or shielding transaction outputs that are awaiting sufficient confirmations for spendability.

pub fn value_pending_spendability(&self) -> Zatoshis

Returns the value of shielded funds that are not yet spendable because additional scanning is required before it will be possible to derive witnesses for the associated notes.

pub fn uneconomic_value(&self) -> Zatoshis

Returns the value in the account of notes and transparent UTXOs that have value less than the marginal fee, and consequently cannot be spent except as a grace input.

Trait Implementations

impl Clone for AccountBalance

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AccountBalance

impl Debug for AccountBalance

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

Formats the value using the given formatter.

impl Eq for AccountBalance

impl PartialEq for AccountBalance

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AccountBalance