Struct orml_tokens::Mapper
source · pub struct Mapper<AccountId, T, C, B, GetCurrencyId>(/* private fields */);
Trait Implementations§
source§impl<AccountId, T, C, B, GetCurrencyId> Inspect<AccountId> for Mapper<AccountId, T, C, B, GetCurrencyId>
impl<AccountId, T, C, B, GetCurrencyId> Inspect<AccountId> for Mapper<AccountId, T, C, B, GetCurrencyId>
source§fn total_issuance() -> Self::Balance
fn total_issuance() -> Self::Balance
The total amount of issuance in the system.
source§fn minimum_balance() -> Self::Balance
fn minimum_balance() -> Self::Balance
The minimum balance any single account may have.
source§fn balance(who: &AccountId) -> Self::Balance
fn balance(who: &AccountId) -> Self::Balance
Get the balance of
who
which does not include funds which are exclusively allocated to
subsystems of the chain (“on hold” or “reserved”). Read moresource§fn total_balance(who: &AccountId) -> Self::Balance
fn total_balance(who: &AccountId) -> Self::Balance
Get the total amount of funds whose ultimate beneficial ownership can be determined as
who
. Read moresource§fn reducible_balance(
who: &AccountId,
preservation: Preservation,
fortitude: Fortitude
) -> Self::Balance
fn reducible_balance( who: &AccountId, preservation: Preservation, fortitude: Fortitude ) -> Self::Balance
Get the maximum amount that
who
can withdraw/transfer successfully based on whether the
account should be kept alive (preservation
) or whether we are willing to force the
reduction and potentially go below user-level restrictions on the minimum amount of the
account. Read moresource§fn can_deposit(
who: &AccountId,
amount: Self::Balance,
provenance: Provenance
) -> DepositConsequence
fn can_deposit( who: &AccountId, amount: Self::Balance, provenance: Provenance ) -> DepositConsequence
source§fn can_withdraw(
who: &AccountId,
amount: Self::Balance
) -> WithdrawConsequence<Self::Balance>
fn can_withdraw( who: &AccountId, amount: Self::Balance ) -> WithdrawConsequence<Self::Balance>
Returns
Success
if the balance of who
may be decreased by amount
, otherwise
the consequence.source§fn active_issuance() -> Self::Balance
fn active_issuance() -> Self::Balance
The total amount of issuance in the system excluding those which are controlled by the
system.
source§impl<AccountId, T, C, B, GetCurrencyId> Mutate<AccountId> for Mapper<AccountId, T, C, B, GetCurrencyId>
impl<AccountId, T, C, B, GetCurrencyId> Mutate<AccountId> for Mapper<AccountId, T, C, B, GetCurrencyId>
source§fn mint_into(
dest: &AccountId,
amount: Self::Balance
) -> Result<Self::Balance, DispatchError>
fn mint_into( dest: &AccountId, amount: Self::Balance ) -> Result<Self::Balance, DispatchError>
Increase the balance of
who
by exactly amount
, minting new tokens. If that isn’t
possible then an Err
is returned and nothing is changed.source§fn burn_from(
dest: &AccountId,
amount: Self::Balance,
precision: Precision,
fortitude: Fortitude
) -> Result<Self::Balance, DispatchError>
fn burn_from( dest: &AccountId, amount: Self::Balance, precision: Precision, fortitude: Fortitude ) -> Result<Self::Balance, DispatchError>
Decrease the balance of
who
by at least amount
, possibly slightly more in the case of
minimum-balance requirements, burning the tokens. If that isn’t possible then an Err
is
returned and nothing is changed. If successful, the amount of tokens reduced is returned.source§fn transfer(
source: &AccountId,
dest: &AccountId,
amount: B,
preservation: Preservation
) -> Result<B, DispatchError>
fn transfer( source: &AccountId, dest: &AccountId, amount: B, preservation: Preservation ) -> Result<B, DispatchError>
Transfer funds from one account into another. Read more
source§fn shelve(
who: &AccountId,
amount: Self::Balance
) -> Result<Self::Balance, DispatchError>
fn shelve( who: &AccountId, amount: Self::Balance ) -> Result<Self::Balance, DispatchError>
source§fn restore(
who: &AccountId,
amount: Self::Balance
) -> Result<Self::Balance, DispatchError>
fn restore( who: &AccountId, amount: Self::Balance ) -> Result<Self::Balance, DispatchError>
source§fn set_balance(who: &AccountId, amount: Self::Balance) -> Self::Balance
fn set_balance(who: &AccountId, amount: Self::Balance) -> Self::Balance
Simple infallible function to force an account to have a particular balance, good for use
in tests and benchmarks but not recommended for production code owing to the lack of
error reporting. Read more
fn done_mint_into(_who: &AccountId, _amount: Self::Balance)
fn done_burn_from(_who: &AccountId, _amount: Self::Balance)
fn done_shelve(_who: &AccountId, _amount: Self::Balance)
fn done_restore(_who: &AccountId, _amount: Self::Balance)
fn done_transfer(_source: &AccountId, _dest: &AccountId, _amount: Self::Balance)
source§impl<AccountId, T, C, B, GetCurrencyId> Unbalanced<AccountId> for Mapper<AccountId, T, C, B, GetCurrencyId>where
T: Unbalanced<AccountId, Balance = B>,
C: ConvertBalance<<T as Inspect<AccountId>>::Balance, B, AssetId = <T as Inspect<AccountId>>::AssetId>,
B: BalanceT,
GetCurrencyId: Get<<T as Inspect<AccountId>>::AssetId>,
impl<AccountId, T, C, B, GetCurrencyId> Unbalanced<AccountId> for Mapper<AccountId, T, C, B, GetCurrencyId>where
T: Unbalanced<AccountId, Balance = B>,
C: ConvertBalance<<T as Inspect<AccountId>>::Balance, B, AssetId = <T as Inspect<AccountId>>::AssetId>,
B: BalanceT,
GetCurrencyId: Get<<T as Inspect<AccountId>>::AssetId>,
source§fn handle_dust(_dust: Dust<AccountId, Self>)
fn handle_dust(_dust: Dust<AccountId, Self>)
source§fn write_balance(
who: &AccountId,
amount: Self::Balance
) -> Result<Option<Self::Balance>, DispatchError>
fn write_balance( who: &AccountId, amount: Self::Balance ) -> Result<Option<Self::Balance>, DispatchError>
source§fn set_total_issuance(amount: Self::Balance)
fn set_total_issuance(amount: Self::Balance)
Set the total issuance to
amount
.source§fn handle_raw_dust(amount: Self::Balance)
fn handle_raw_dust(amount: Self::Balance)
Create some dust and handle it with
Unbalanced::handle_dust
. This is an unbalanced
operation and it must only be used when an account is modified in a raw fashion, outside of
the entire fungibles API. The amount
is capped at Inspect::minimum_balance()
- 1`. Read moresource§fn decrease_balance(
who: &AccountId,
amount: Self::Balance,
precision: Precision,
preservation: Preservation,
force: Fortitude
) -> Result<Self::Balance, DispatchError>
fn decrease_balance( who: &AccountId, amount: Self::Balance, precision: Precision, preservation: Preservation, force: Fortitude ) -> Result<Self::Balance, DispatchError>
source§fn increase_balance(
who: &AccountId,
amount: Self::Balance,
precision: Precision
) -> Result<Self::Balance, DispatchError>
fn increase_balance( who: &AccountId, amount: Self::Balance, precision: Precision ) -> Result<Self::Balance, DispatchError>
source§fn deactivate(_: Self::Balance)
fn deactivate(_: Self::Balance)
Reduce the active issuance by some amount.
source§fn reactivate(_: Self::Balance)
fn reactivate(_: Self::Balance)
Increase the active issuance by some amount, up to the outstanding amount reduced.
Auto Trait Implementations§
impl<AccountId, T, C, B, GetCurrencyId> Freeze for Mapper<AccountId, T, C, B, GetCurrencyId>
impl<AccountId, T, C, B, GetCurrencyId> RefUnwindSafe for Mapper<AccountId, T, C, B, GetCurrencyId>where
AccountId: RefUnwindSafe,
T: RefUnwindSafe,
C: RefUnwindSafe,
B: RefUnwindSafe,
GetCurrencyId: RefUnwindSafe,
impl<AccountId, T, C, B, GetCurrencyId> Send for Mapper<AccountId, T, C, B, GetCurrencyId>
impl<AccountId, T, C, B, GetCurrencyId> Sync for Mapper<AccountId, T, C, B, GetCurrencyId>
impl<AccountId, T, C, B, GetCurrencyId> Unpin for Mapper<AccountId, T, C, B, GetCurrencyId>
impl<AccountId, T, C, B, GetCurrencyId> UnwindSafe for Mapper<AccountId, T, C, B, GetCurrencyId>where
AccountId: UnwindSafe,
T: UnwindSafe,
C: UnwindSafe,
B: UnwindSafe,
GetCurrencyId: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T, Outer> IsWrappedBy<Outer> for T
impl<T, Outer> IsWrappedBy<Outer> for T
source§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
source§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
source§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
Consume self to return an equivalent value of
T
. Read moresource§impl<T, U> TryIntoKey<U> for Twhere
U: TryFromKey<T>,
impl<T, U> TryIntoKey<U> for Twhere
U: TryFromKey<T>,
type Error = <U as TryFromKey<T>>::Error
fn try_into_key(self) -> Result<U, <U as TryFromKey<T>>::Error>
source§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
source§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
The counterpart to
unchecked_from
.source§impl<T, S> UniqueSaturatedInto<T> for S
impl<T, S> UniqueSaturatedInto<T> for S
source§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
Consume self to return an equivalent value of
T
.