Struct Imbalance

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

Trait Implementations

impl<B: Balance, OnDrop: HandleImbalanceDrop<B>, OppositeOnDrop: HandleImbalanceDrop<B>> Debug for Imbalance<B, OnDrop, OppositeOnDrop>

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

Formats the value using the given formatter.

impl<B: Balance, OnDrop: HandleImbalanceDrop<B>, OppositeOnDrop: HandleImbalanceDrop<B>> Default for Imbalance<B, OnDrop, OppositeOnDrop>

fn default() -> Self

Returns the “default value” for a type.

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

fn drop(&mut self)

Executes the destructor for this type.

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

type Opposite = Imbalance<B, OppositeOnDrop, OnDrop>

The oppositely imbalanced type. They come in pairs.

fn zero() -> Self

The zero imbalance. Can be destroyed with drop_zero.

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

Drop an instance cleanly. Only works if its self.value() is zero.

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

Consume self and return two independent instances; the first is guaranteed to be at most amount and the second will be the remainder.

fn extract(&mut self, amount: B) -> Self

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

fn merge(self, other: Self) -> Self

Consume self and an other to return a new instance that combines both.

fn subsume(&mut self, other: Self)

Consume an other to mutate self into a new instance that combines both.

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

Consume self and along with an opposite counterpart to return a combined result.

fn peek(&self) -> B

The raw value of self.

fn ration(self, first: u32, second: u32) -> (Self, Self)

where Balance: From<u32> + Saturating + Div<Output = Balance>,

Consume self and return two independent instances; the amounts returned will be in approximately the same ratio as first:second.

fn split_merge(self, amount: Balance, others: (Self, Self)) -> (Self, Self)

Consume self and add its two components, defined by the first component’s balance, element-wise to two pre-existing Imbalances.

fn ration_merge( self, first: u32, second: u32, others: (Self, Self), ) -> (Self, Self)

where Balance: From<u32> + Saturating + Div<Output = Balance>,

Consume self and add its two components, defined by the ratio first:second, element-wise to two pre-existing Imbalances.

fn split_merge_into(self, amount: Balance, others: &mut (Self, Self))

Consume self and add its two components, defined by the first component’s balance, element-wise into two pre-existing Imbalance refs.

fn ration_merge_into(self, first: u32, second: u32, others: &mut (Self, Self))

where Balance: From<u32> + Saturating + Div<Output = Balance>,

Consume self and add its two components, defined by the ratio first:second, element-wise to two pre-existing Imbalances.

fn merge_into(self, other: &mut Self)

Consume self to mutate other so that it combines both. Just like subsume, only with reversed arguments.

fn maybe_merge(self, other: Option<Self>) -> Self

Consume self and maybe an other to return a new instance that combines both.

fn maybe_subsume(&mut self, other: Option<Self>)

Maybe consume an other to mutate self into a new instance that combines both.

impl<A: TypedGet, F: Balanced<A::Type>> OnUnbalanced<Imbalance<<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 ResolveTo<A, F>

fn on_nonzero_unbalanced(credit: Credit<A::Type, F>)

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

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<B: Balance, OnDrop: HandleImbalanceDrop<B>, OppositeOnDrop: HandleImbalanceDrop<B>> TryDrop for Imbalance<B, OnDrop, OppositeOnDrop>

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

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

impl<B: Balance, OnDrop: HandleImbalanceDrop<B>, OppositeOnDrop: HandleImbalanceDrop<B>> TryMerge for Imbalance<B, OnDrop, OppositeOnDrop>

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

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