Struct frame_support::traits::tokens::fungibles::Imbalance

pub struct Imbalance<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: AssetId, B: Balance, OnDrop: HandleImbalanceDrop<A, B>, OppositeOnDrop: HandleImbalanceDrop<A, B>> Imbalance<A, B, OnDrop, OppositeOnDrop>

pub fn zero(asset: A) -> Self

pub fn drop_zero(self) -> Result<(), Self>

pub fn split(self, amount: B) -> (Self, Self)

pub fn merge(self, other: Self) -> Result<Self, (Self, Self)>

pub fn subsume(&mut self, other: Self) -> Result<(), Self>

pub fn offset(
    self,
    other: Imbalance<A, B, OppositeOnDrop, OnDrop>
) -> Result<SameOrOther<Self, Imbalance<A, B, OppositeOnDrop, OnDrop>>, (Self, 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: Debug + AssetId,
    B: Debug + Balance,
    OnDrop: Debug + HandleImbalanceDrop<A, B>,
    OppositeOnDrop: Debug + HandleImbalanceDrop<A, B>,

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

Formats the value using the given formatter.

impl<A: AssetId, B: Balance, OnDrop: HandleImbalanceDrop<A, B>, OppositeOnDrop: HandleImbalanceDrop<A, B>> Drop for Imbalance<A, B, OnDrop, OppositeOnDrop>

fn drop(&mut self)

Executes the destructor for this type.

impl<A: PartialEq + AssetId, B: PartialEq + Balance, OnDrop: PartialEq + HandleImbalanceDrop<A, B>, OppositeOnDrop: PartialEq + HandleImbalanceDrop<A, B>> PartialEq<Imbalance<A, B, OnDrop, OppositeOnDrop>> for Imbalance<A, B, OnDrop, OppositeOnDrop>

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: AssetId, B: Balance, OnDrop: HandleImbalanceDrop<A, B>, OppositeOnDrop: HandleImbalanceDrop<A, B>> TryDrop for Imbalance<A, B, OnDrop, OppositeOnDrop>

fn try_drop(self) -> Result<(), Self>

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

impl<A: Eq + AssetId, B: Eq + Balance, OnDrop: Eq + HandleImbalanceDrop<A, B>, OppositeOnDrop: Eq + HandleImbalanceDrop<A, B>> Eq for Imbalance<A, B, OnDrop, OppositeOnDrop>

impl<A: AssetId, B: Balance, OnDrop: HandleImbalanceDrop<A, B>, OppositeOnDrop: HandleImbalanceDrop<A, B>> StructuralEq for Imbalance<A, B, OnDrop, OppositeOnDrop>

impl<A: AssetId, B: Balance, OnDrop: HandleImbalanceDrop<A, B>, OppositeOnDrop: HandleImbalanceDrop<A, B>> StructuralPartialEq for Imbalance<A, B, OnDrop, OppositeOnDrop>