Struct pallet_balances::types::AccountData

pub struct AccountData<Balance> {
    pub free: Balance,
    pub reserved: Balance,
    pub frozen: Balance,
    pub flags: ExtraFlags,
}

All balance information for an account.

Fields

free: Balance

Non-reserved part of the balance which the account holder may be able to control.

This is the only balance that matters in terms of most operations on tokens.

reserved: Balance

Balance which is has active holds on it and may not be used at all.

This is the sum of all individual holds together with any sums still under the (deprecated) reserves API.

frozen: Balance

The amount that free + reserved may not drop below when reducing the balance, except for actions where the account owner cannot reasonably benefit from the balance reduction, such as slashing.

flags: ExtraFlags

Extra information about this account. The MSB is a flag indicating whether the new ref- counting logic is in place for this account.

Implementations

impl<Balance: Saturating + Copy + Ord> AccountData<Balance>

pub fn usable(&self) -> Balance

pub fn total(&self) -> Balance

The total balance in this account including any that is reserved and ignoring any frozen.

Trait Implementations

impl<Balance: Clone> Clone for AccountData<Balance>

fn clone(&self) -> AccountData<Balance>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Balance> Debug for AccountData<Balance>

where Balance: Debug,

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

Formats the value using the given formatter.

impl<Balance> Decode for AccountData<Balance>

where Balance: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<Balance: Default> Default for AccountData<Balance>

fn default() -> AccountData<Balance>

Returns the “default value” for a type.

impl<Balance> Encode for AccountData<Balance>

where Balance: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<Balance> MaxEncodedLen for AccountData<Balance>

where Balance: MaxEncodedLen,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<Balance: PartialEq> PartialEq for AccountData<Balance>

fn eq(&self, other: &AccountData<Balance>) -> 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<Balance> TypeInfo for AccountData<Balance>

where Balance: TypeInfo + 'static,

type Identity = AccountData<Balance>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<Balance> EncodeLike for AccountData<Balance>

where Balance: Encode,

impl<Balance: Eq> Eq for AccountData<Balance>

impl<Balance> StructuralPartialEq for AccountData<Balance>