Enum BalanceResult

pub enum BalanceResult {
    RootNotFound,
    Success {
        purse_addr: URefAddr,
        total_balance: U512,
        available_balance: U512,
        proofs_result: ProofsResult,
    },
    Failure(TrackingCopyError),
}

Result enum that represents all possible outcomes of a balance request.

Variants

RootNotFound

Returned if a passed state root hash is not found.

Success

A query returned a balance.

Fields

purse_addr: URefAddr

The purse address.

total_balance: U512

The purses total balance, not considering holds.

available_balance: U512

The available balance (total balance - sum of all active holds).

proofs_result: ProofsResult

Proofs result.

Failure(TrackingCopyError)

Failure.

Implementations

impl BalanceResult

pub fn purse_addr(&self) -> Option<URefAddr>

Returns the purse address for a BalanceResult::Success variant.

pub fn total_balance(&self) -> Option<&U512>

Returns the total balance for a BalanceResult::Success variant.

pub fn available_balance(&self) -> Option<&U512>

Returns the available balance for a BalanceResult::Success variant.

pub fn proofs_result(self) -> Option<ProofsResult>

Returns the Merkle proofs, if any.

pub fn is_sufficient(&self, cost: U512) -> bool

Is the available balance sufficient to cover the cost?

pub fn is_success(&self) -> bool

Was the balance request successful?

pub fn error(&self) -> Option<&TrackingCopyError>

Tracking copy error, if any.

Trait Implementations

impl Clone for BalanceResult

fn clone(&self) -> BalanceResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BalanceResult

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

Formats the value using the given formatter.

impl From<Error> for BalanceResult

fn from(tce: TrackingCopyError) -> Self

Converts to this type from the input type.