referrerpolicy=no-referrer-when-downgrade
polkadot_sdk_frame::token::currency

Struct ReservableWithName

pub struct ReservableWithName<NamedReservable, Id, AccountId>(/* private fields */);
Expand description

Adapter to allow a NamedReservableCurrency to be passed as regular ReservableCurrency together with an Id.

All “anonymous” operations are then implemented as their named counterparts with the given Id.

Trait Implementations§

§

impl<NamedReservable, Id, AccountId> Currency<AccountId> for ReservableWithName<NamedReservable, Id, AccountId>
where NamedReservable: NamedReservableCurrency<AccountId>, Id: Get<<NamedReservable as NamedReservableCurrency<AccountId>>::ReserveIdentifier>,

§

type Balance = <NamedReservable as Currency<AccountId>>::Balance

The balance of an account.
§

type PositiveImbalance = <NamedReservable as Currency<AccountId>>::PositiveImbalance

The opaque token type for an imbalance. This is returned by unbalanced operations and must be dealt with. It may be dropped but cannot be cloned.
§

type NegativeImbalance = <NamedReservable as Currency<AccountId>>::NegativeImbalance

The opaque token type for an imbalance. This is returned by unbalanced operations and must be dealt with. It may be dropped but cannot be cloned.
§

fn total_balance( who: &AccountId, ) -> <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance

The combined balance of who.
§

fn can_slash( who: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, ) -> bool

Same result as slash(who, value) (but without the side-effects) assuming there are no balance changes in the meantime and only the reserved balance is not taken into account.
§

fn total_issuance() -> <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance

The total amount of issuance in the system.
§

fn minimum_balance() -> <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance

The minimum balance any single account may have. This is equivalent to the Balances module’s ExistentialDeposit.
§

fn burn( amount: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, ) -> <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::PositiveImbalance

Reduce the total issuance by amount and return the according imbalance. The imbalance will typically be used to reduce an account by the same amount with e.g. settle. Read more
§

fn issue( amount: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, ) -> <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::NegativeImbalance

Increase the total issuance by amount and return the according imbalance. The imbalance will typically be used to increase an account by the same amount with e.g. resolve_into_existing or resolve_creating. Read more
§

fn pair( amount: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, ) -> (<ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::PositiveImbalance, <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::NegativeImbalance)

Produce a pair of imbalances that cancel each other out exactly. Read more
§

fn free_balance( who: &AccountId, ) -> <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance

The ‘free’ balance of a given account. Read more
§

fn ensure_can_withdraw( who: &AccountId, amount: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, reasons: WithdrawReasons, new_balance: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, ) -> Result<(), DispatchError>

Returns Ok iff the account is able to make a withdrawal of the given amount for the given reason. Basically, it’s just a dry-run of withdraw. Read more
§

fn transfer( source: &AccountId, dest: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, existence_requirement: ExistenceRequirement, ) -> Result<(), DispatchError>

Transfer some liquid free balance to another staker. Read more
§

fn slash( who: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, ) -> (<ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::NegativeImbalance, <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance)

Deducts up to value from the combined balance of who, preferring to deduct from the free balance. This function cannot fail. Read more
§

fn deposit_into_existing( who: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, ) -> Result<<ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::PositiveImbalance, DispatchError>

Mints value to the free balance of who. Read more
§

fn resolve_into_existing( who: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::NegativeImbalance, ) -> Result<(), <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::NegativeImbalance>

Similar to deposit_creating, only accepts a NegativeImbalance and returns nothing on success.
§

fn deposit_creating( who: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, ) -> <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::PositiveImbalance

Adds up to value to the free balance of who. If who doesn’t exist, it is created. Read more
§

fn resolve_creating( who: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::NegativeImbalance, )

Similar to deposit_creating, only accepts a NegativeImbalance and returns nothing on success.
§

fn withdraw( who: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, reasons: WithdrawReasons, liveness: ExistenceRequirement, ) -> Result<<ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::NegativeImbalance, DispatchError>

Removes some free balance from who account for reason if possible. If liveness is KeepAlive, then no less than ExistentialDeposit must be left remaining. Read more
§

fn settle( who: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::PositiveImbalance, reasons: WithdrawReasons, liveness: ExistenceRequirement, ) -> Result<(), <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::PositiveImbalance>

Similar to withdraw, only accepts a PositiveImbalance and returns nothing on success.
§

fn make_free_balance_be( who: &AccountId, balance: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, ) -> SignedImbalance<<ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::PositiveImbalance>

Ensure an account’s free balance equals some value; this will create the account if needed. Read more
§

fn active_issuance() -> Self::Balance

The total amount of issuance in the system excluding those which are controlled by the system.
§

fn deactivate(_: Self::Balance)

Reduce the active issuance by some amount.
§

fn reactivate(_: Self::Balance)

Increase the active issuance by some amount, up to the outstanding amount reduced.
§

impl<NamedReservable, Id, AccountId> ReservableCurrency<AccountId> for ReservableWithName<NamedReservable, Id, AccountId>
where NamedReservable: NamedReservableCurrency<AccountId>, Id: Get<<NamedReservable as NamedReservableCurrency<AccountId>>::ReserveIdentifier>,

§

fn can_reserve( who: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, ) -> bool

Same result as reserve(who, value) (but without the side-effects) assuming there are no balance changes in the meantime.
§

fn slash_reserved( who: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, ) -> (<ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::NegativeImbalance, <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance)

Deducts up to value from reserved balance of who. This function cannot fail. Read more
§

fn reserved_balance( who: &AccountId, ) -> <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance

The amount of the balance of a given account that is externally reserved; this can still get slashed, but gets slashed last of all. Read more
§

fn reserve( who: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, ) -> Result<(), DispatchError>

Moves value from balance to reserved balance. Read more
§

fn unreserve( who: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, ) -> <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance

Moves up to value from reserved balance to free balance. This function cannot fail. Read more
§

fn repatriate_reserved( slashed: &AccountId, beneficiary: &AccountId, value: <ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, status: BalanceStatus, ) -> Result<<ReservableWithName<NamedReservable, Id, AccountId> as Currency<AccountId>>::Balance, DispatchError>

Moves up to value from reserved balance of account slashed to balance of account beneficiary. beneficiary must exist for this to succeed. If it does not, Err will be returned. Funds will be placed in either the free balance or the reserved balance, depending on the status. Read more

Auto Trait Implementations§

§

impl<NamedReservable, Id, AccountId> Freeze for ReservableWithName<NamedReservable, Id, AccountId>

§

impl<NamedReservable, Id, AccountId> RefUnwindSafe for ReservableWithName<NamedReservable, Id, AccountId>
where NamedReservable: RefUnwindSafe, Id: RefUnwindSafe, AccountId: RefUnwindSafe,

§

impl<NamedReservable, Id, AccountId> Send for ReservableWithName<NamedReservable, Id, AccountId>
where NamedReservable: Send, Id: Send, AccountId: Send,

§

impl<NamedReservable, Id, AccountId> Sync for ReservableWithName<NamedReservable, Id, AccountId>
where NamedReservable: Sync, Id: Sync, AccountId: Sync,

§

impl<NamedReservable, Id, AccountId> Unpin for ReservableWithName<NamedReservable, Id, AccountId>
where NamedReservable: Unpin, Id: Unpin, AccountId: Unpin,

§

impl<NamedReservable, Id, AccountId> UnwindSafe for ReservableWithName<NamedReservable, Id, AccountId>
where NamedReservable: UnwindSafe, Id: UnwindSafe, AccountId: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CheckedConversion for T

§

fn checked_from<T>(t: T) -> Option<Self>
where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more
§

fn checked_into<T>(self) -> Option<T>
where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T, U> DefensiveTruncateInto<U> for T
where U: DefensiveTruncateFrom<T>,

§

fn defensive_truncate_into(self) -> U

Defensively truncate a value and convert it into its bounded form.
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

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 more
§

impl<T, U> IntoKey<U> for T
where U: FromKey<T>,

§

fn into_key(self) -> U

§

impl<Src, Dest> IntoTuple<Dest> for Src
where Dest: FromTuple<Src>,

§

fn into_tuple(self) -> Dest

§

impl<T> IsType<T> for T

§

fn from_ref(t: &T) -> &T

Cast reference.
§

fn into_ref(&self) -> &T

Cast reference.
§

fn from_mut(t: &mut T) -> &mut T

Cast mutable reference.
§

fn into_mut(&mut self) -> &mut T

Cast mutable reference.
§

impl<T, Outer> IsWrappedBy<Outer> for T
where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

§

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

§

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> SaturatedConversion for T

§

fn saturated_from<T>(t: T) -> Self
where Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more
§

fn saturated_into<T>(self) -> T
where Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T, U> TryIntoKey<U> for T
where U: TryFromKey<T>,

§

type Error = <U as TryFromKey<T>>::Error

§

fn try_into_key(self) -> Result<U, <U as TryFromKey<T>>::Error>

§

impl<S, T> UncheckedInto<T> for S
where T: UncheckedFrom<S>,

§

fn unchecked_into(self) -> T

The counterpart to unchecked_from.
§

impl<T, S> UniqueSaturatedInto<T> for S
where T: Bounded, S: TryInto<T>,

§

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> JsonSchemaMaybe for T

§

impl<T> MaybeRefUnwindSafe for T
where T: RefUnwindSafe,