Struct orml_tokens::NegativeImbalance

pub struct NegativeImbalance<T: Config, GetCurrencyId: Get<T::CurrencyId>>(_, _);

Opaque, move-only struct with private fields that serves as a token denoting that funds have been destroyed without any equal and opposite accounting.

Implementations

impl<T: Config, GetCurrencyId: Get<T::CurrencyId>> NegativeImbalance<T, GetCurrencyId>

pub fn new(amount: T::Balance) -> Self

Create a new negative imbalance from a balance.

Trait Implementations

impl<T: Config, GetCurrencyId: Get<T::CurrencyId>> Default for NegativeImbalance<T, GetCurrencyId>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Config, GetCurrencyId: Get<T::CurrencyId>> Drop for NegativeImbalance<T, GetCurrencyId>

fn drop(&mut self)

Basic drop handler will just square up the total issuance.

impl<T: Config, GetCurrencyId: Get<T::CurrencyId>> Imbalance<<T as Config>::Balance> for NegativeImbalance<T, GetCurrencyId>

type Opposite = PositiveImbalance<T, GetCurrencyId>

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: T::Balance) -> (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 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: Self::Opposite) -> SameOrOther<Self, Self::Opposite>

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

fn peek(&self) -> T::Balance

The raw value of self.

fn ration(self, first: u32, second: u32) -> (Self, Self) where
    Balance: From<u32> + Saturating + Div<Balance, 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<Balance, 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<Balance, 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<T: Config, GetCurrencyId: Get<T::CurrencyId>> TryDrop for NegativeImbalance<T, GetCurrencyId>

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

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