Struct governance_os_pallet_tokens::AccountCurrencyData

pub struct AccountCurrencyData<Balance> {
    pub free: Balance,
    pub reserved: Balance,
    pub frozen: Balance,
}

All balance information for an account and an associated currency.

Fields

free: Balance

Non-reserved part of the balance. There may still be restrictions on this, but it is the total pool what may in principle be transferred, reserved and used for tipping.

This is the only balance that matters in terms of most operations on tokens. It alone is used to determine the balance when in the contract execution environment.

reserved: Balance

Balance which is reserved and may not be used at all.

This can still get slashed, but gets slashed last of all.

This balance is a ‘reserve’ balance that other subsystems use in order to set aside tokens that are still ‘owned’ by the account holder, but which are suspendable.

frozen: Balance

Balance under which the free balance may never drop below.

Implementations

impl<Balance: Saturating + Copy> AccountCurrencyData<Balance>

pub fn total(&self) -> Balance

Computes and return the total balance, including reserved funds.

Trait Implementations

impl<Balance: Clone> Clone for AccountCurrencyData<Balance>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Balance> Debug for AccountCurrencyData<Balance> where
    Balance: Debug, 

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

Formats the value using the given formatter.

impl<Balance> Decode for AccountCurrencyData<Balance> where
    Balance: Decode,
    Balance: Decode,
    Balance: Decode,
    Balance: Decode,
    Balance: Decode,
    Balance: Decode, 

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

Attempt to deserialise the value from input.

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

Attempt to skip the encoded value from input.

pub fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<Balance: Default> Default for AccountCurrencyData<Balance>

fn default() -> AccountCurrencyData<Balance>

Returns the “default value” for a type.

impl<Balance> Encode for AccountCurrencyData<Balance> where
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,
    Balance: Encode, 

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

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

pub fn size_hint(&self) -> usize

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

pub fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

pub 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.

pub fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<Balance: PartialEq> PartialEq<AccountCurrencyData<Balance>> for AccountCurrencyData<Balance>

fn eq(&self, other: &AccountCurrencyData<Balance>) -> bool

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

fn ne(&self, other: &AccountCurrencyData<Balance>) -> bool

This method tests for !=.

impl<T: Config> StorageDoubleMap<<T as Config>::AccountId, <T as Config>::CurrencyId, AccountCurrencyData<<T as Config>::Balance>> for Balances<T>

type Query = AccountCurrencyData<T::Balance>

The type that get/take returns.

type Hasher1 = Blake2_128Concat

Hasher for the first key.

type Hasher2 = Blake2_128Concat

Hasher for the second key.

fn module_prefix() -> &'static [u8]

Module prefix. Used for generating final key.

fn storage_prefix() -> &'static [u8]

Storage prefix. Used for generating final key.

fn from_optional_value_to_query(
    v: Option<AccountCurrencyData<T::Balance>>
) -> Self::Query

Convert an optional value retrieved from storage to the type queried.

fn from_query_to_optional_value(
    v: Self::Query
) -> Option<AccountCurrencyData<T::Balance>>

Convert a query to an optional value into storage.

pub fn prefix_hash() -> Vec<u8, Global>

The full prefix; just the hash of module_prefix concatenated to the hash of storage_prefix.

pub fn storage_double_map_final_key1<KArg1>(k1: KArg1) -> Vec<u8, Global> where
    KArg1: EncodeLike<K1>, 

Generate the first part of the key used in top storage.

pub fn storage_double_map_final_key<KArg1, KArg2>(
    k1: KArg1,
    k2: KArg2
) -> Vec<u8, Global> where
    KArg1: EncodeLike<K1>,
    KArg2: EncodeLike<K2>, 

Generate the full key used in top storage.

impl<T: Config> StoragePrefixedMap<AccountCurrencyData<<T as Config>::Balance>> for Balances<T>

fn module_prefix() -> &'static [u8]

Module prefix. Used for generating final key.

fn storage_prefix() -> &'static [u8]

Storage prefix. Used for generating final key.

pub fn final_prefix() -> [u8; 32]

Final full prefix that prefixes all keys.

pub fn remove_all()

Remove all value of the storage.

pub fn iter_values() -> PrefixIterator<Value>

Iter over all value of the storage.

pub fn translate_values<OldValue, F>(f: F) where
    F: FnMut(OldValue) -> Option<Value>,
    OldValue: Decode, 

Translate the values of all elements by a function f, in the map in no particular order. By returning None from f for an element, you’ll remove it from the map.

impl<Balance> EncodeLike<AccountCurrencyData<Balance>> for AccountCurrencyData<Balance> where
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,
    Balance: Encode, 

impl<Balance: Eq> Eq for AccountCurrencyData<Balance>

impl<Balance> StructuralEq for AccountCurrencyData<Balance>

impl<Balance> StructuralPartialEq for AccountCurrencyData<Balance>