Struct concordium_std::AccountBalance

pub struct AccountBalance {
    pub total: Amount,
    pub staked: Amount,
    pub locked: Amount,
}

The current public balances of an account.

Fields

total: Amount

The total balance of the account. Note that part of this balance might be staked and/or locked in scheduled transfers.

staked: Amount

The current staked amount of the account. This amount is used for staking.

locked: Amount

The current amount locked in releases that resulted from transfers with schedule. A locked amount can still be used for staking.

Implementations

impl AccountBalance

pub fn new( total: Amount, staked: Amount, locked: Amount ) -> Option<AccountBalance>

Construct a new account balance, ensuring that both the staked amount and the locked amount is smaller than or equal to the total balance.

pub fn available(&self) -> Amount

The current available balance of the account. This is the amount an account currently has available for transferring and is not staked or locked in releases by scheduled transfers.

Trait Implementations

impl Clone for AccountBalance

fn clone(&self) -> AccountBalance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccountBalance

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

Formats the value using the given formatter.

impl Deserial for AccountBalance

fn deserial<R>(source: &mut R) -> Result<AccountBalance, ParseError>

where R: Read,

Attempt to read a structure from a given source, failing if an error occurs during deserialization or reading.

impl Ord for AccountBalance

fn cmp(&self, other: &AccountBalance) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for AccountBalance

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AccountBalance

fn partial_cmp(&self, other: &AccountBalance) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serial for AccountBalance

fn serial<W>(&self, out: &mut W) -> Result<(), <W as Write>::Err>

where W: Write,

Attempt to write the structure into the provided writer, failing if only part of the structure could be written.

impl Copy for AccountBalance

impl Eq for AccountBalance

impl StructuralPartialEq for AccountBalance