Struct polkadot_sdk_frame::traits::tokens::fungibles::Imbalance

pub struct Imbalance<A, B, OnDrop, OppositeOnDrop>
where
    A: AssetId,
    B: Balance,
    OnDrop: HandleImbalanceDrop<A, B>,
    OppositeOnDrop: HandleImbalanceDrop<A, B>,
{ /* private fields */ }

An imbalance in the system, representing a divergence of recorded token supply from the sum of the balances of all accounts. This is must_use in order to ensure it gets handled (placing into an account, settling from an account or altering the supply).

Importantly, it has a special Drop impl, and cannot be created outside of this module.

Implementations

impl<A, B, OnDrop, OppositeOnDrop> Imbalance<A, B, OnDrop, OppositeOnDrop>

where A: AssetId, B: Balance, OnDrop: HandleImbalanceDrop<A, B>, OppositeOnDrop: HandleImbalanceDrop<A, B>,

pub fn zero(asset: A) -> Imbalance<A, B, OnDrop, OppositeOnDrop>

pub fn drop_zero(self) -> Result<(), Imbalance<A, B, OnDrop, OppositeOnDrop>>

pub fn split( self, amount: B, ) -> (Imbalance<A, B, OnDrop, OppositeOnDrop>, Imbalance<A, B, OnDrop, OppositeOnDrop>)

pub fn extract(&mut self, amount: B) -> Imbalance<A, B, OnDrop, OppositeOnDrop>

Mutate self by extracting a new instance with at most amount value, reducing self accordingly.

pub fn merge( self, other: Imbalance<A, B, OnDrop, OppositeOnDrop>, ) -> Result<Imbalance<A, B, OnDrop, OppositeOnDrop>, (Imbalance<A, B, OnDrop, OppositeOnDrop>, Imbalance<A, B, OnDrop, OppositeOnDrop>)>

pub fn subsume( &mut self, other: Imbalance<A, B, OnDrop, OppositeOnDrop>, ) -> Result<(), Imbalance<A, B, OnDrop, OppositeOnDrop>>

pub fn offset( self, other: Imbalance<A, B, OppositeOnDrop, OnDrop>, ) -> Result<SameOrOther<Imbalance<A, B, OnDrop, OppositeOnDrop>, Imbalance<A, B, OppositeOnDrop, OnDrop>>, (Imbalance<A, B, OnDrop, OppositeOnDrop>, Imbalance<A, B, OppositeOnDrop, OnDrop>)>

pub fn peek(&self) -> B

pub fn asset(&self) -> A

Trait Implementations

impl<A, B, OnDrop, OppositeOnDrop> Debug for Imbalance<A, B, OnDrop, OppositeOnDrop>

where A: AssetId, B: Balance, OnDrop: HandleImbalanceDrop<A, B>, OppositeOnDrop: HandleImbalanceDrop<A, B>,

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

Formats the value using the given formatter.

impl<A, B, OnDrop, OppositeOnDrop> Drop for Imbalance<A, B, OnDrop, OppositeOnDrop>

where A: AssetId, B: Balance, OnDrop: HandleImbalanceDrop<A, B>, OppositeOnDrop: HandleImbalanceDrop<A, B>,

fn drop(&mut self)

Executes the destructor for this type.

impl<A, F> OnUnbalanced<Imbalance<<F as Inspect<<A as TypedGet>::Type>>::AssetId, <F as Inspect<<A as TypedGet>::Type>>::Balance, <F as Balanced<<A as TypedGet>::Type>>::OnDropCredit, <F as Balanced<<A as TypedGet>::Type>>::OnDropDebt>> for ResolveAssetTo<A, F>

where A: TypedGet, F: Balanced<<A as TypedGet>::Type>,

fn on_nonzero_unbalanced( credit: Imbalance<<F as Inspect<<A as TypedGet>::Type>>::AssetId, <F as Inspect<<A as TypedGet>::Type>>::Balance, <F as Balanced<<A as TypedGet>::Type>>::OnDropCredit, <F as Balanced<<A as TypedGet>::Type>>::OnDropDebt>, )

Actually handle a non-zero imbalance. You probably want to implement this rather than on_unbalanced.

fn on_unbalanceds(amounts: impl Iterator<Item = Imbalance>)

where Imbalance: TryMerge,

Handler for some imbalances. The different imbalances might have different origins or meanings, dependent on the context. Will default to simply calling on_unbalanced for all of them. Infallible.

fn on_unbalanced(amount: Imbalance)

Handler for some imbalance. Infallible.

impl<A, B, OnDrop, OppositeOnDrop> PartialEq for Imbalance<A, B, OnDrop, OppositeOnDrop>

where A: AssetId, B: Balance, OnDrop: HandleImbalanceDrop<A, B>, OppositeOnDrop: HandleImbalanceDrop<A, B>,

fn eq(&self, other: &Imbalance<A, B, OnDrop, OppositeOnDrop>) -> 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<A, B, OnDrop, OppositeOnDrop> TryDrop for Imbalance<A, B, OnDrop, OppositeOnDrop>

where A: AssetId, B: Balance, OnDrop: HandleImbalanceDrop<A, B>, OppositeOnDrop: HandleImbalanceDrop<A, B>,

fn try_drop(self) -> Result<(), Imbalance<A, B, OnDrop, OppositeOnDrop>>

Drop an instance cleanly. Only works if its value represents “no-operation”.

impl<A, B, OnDrop, OppositeOnDrop> TryMerge for Imbalance<A, B, OnDrop, OppositeOnDrop>

where A: AssetId, B: Balance, OnDrop: HandleImbalanceDrop<A, B>, OppositeOnDrop: HandleImbalanceDrop<A, B>,

fn try_merge( self, other: Imbalance<A, B, OnDrop, OppositeOnDrop>, ) -> Result<Imbalance<A, B, OnDrop, OppositeOnDrop>, (Imbalance<A, B, OnDrop, OppositeOnDrop>, Imbalance<A, B, OnDrop, OppositeOnDrop>)>

Consume self and an other to return a new instance that combines both. Errors with Err(self, other) if the imbalances cannot be merged (e.g. imbalances of different assets).

impl<A, B, OnDrop, OppositeOnDrop> Eq for Imbalance<A, B, OnDrop, OppositeOnDrop>

where A: AssetId, B: Balance, OnDrop: HandleImbalanceDrop<A, B>, OppositeOnDrop: HandleImbalanceDrop<A, B>,