Struct BalanceSummary 

pub struct BalanceSummary {
    pub spendable: Amount,
    pub needs_refresh: Amount,
    pub pending: Amount,
    pub total: Amount,
}

The wallet balance without the breakdown of Balance: what a user can pay with, what is held by operations in progress and what the user owns. Build it from a Balance.

All amounts are in sats.

Fields

spendable: Amount

Sats that can be spent right now. See spendable_sat of Balance.

needs_refresh: Amount

Sats that need a refresh before they can be sent again. See needs_refresh_sat of Balance.

pending: Amount

Sats held by operations in progress: the sum of the pending_*_sat fields of Balance. They either come back as spendable or leave the wallet, for example to the on-chain wallet.

total: Amount

All sats that belong to the wallet: spendable_sat + needs_refresh_sat + pending_sat.

Trait Implementations

impl Clone for BalanceSummary

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BalanceSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BalanceSummary

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BalanceSummary

impl From<&Balance> for BalanceSummary

fn from(v: &Balance) -> Self

Converts to this type from the input type.

impl From<Balance> for BalanceSummary

fn from(v: Balance) -> Self

Converts to this type from the input type.

impl From<BalanceSummary> for BalanceSummary

fn from(v: BalanceSummary) -> Self

Converts to this type from the input type.

impl PartialEq for BalanceSummary

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BalanceSummary

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BalanceSummary