Struct orml_tokens::AccountData

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

balance information for an account.

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.

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

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

The amount that free may not drop below when withdrawing.

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 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 encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

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

fn size_hint(&self) -> usize

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

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    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<AccountData<Balance>> 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<AccountData<Balance>> for AccountData<Balance>where
    Balance: Encode,

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

impl<Balance> StructuralEq for AccountData<Balance>

impl<Balance> StructuralPartialEq for AccountData<Balance>