Enum pallet_contracts_primitives::StorageDeposit

pub enum StorageDeposit<Balance> {
    Refund(Balance),
    Charge(Balance),
}

The amount of balance that was either charged or refunded in order to pay for storage.

Variants

Refund(Balance)

The transaction reduced storage consumption.

This means that the specified amount of balance was transferred from the involved deposit accounts to the origin.

Charge(Balance)

The transaction increased storage consumption.

This means that the specified amount of balance was transferred from the origin to the involved deposit accounts.

Implementations

impl<Balance: Zero + Copy> StorageDeposit<Balance>

pub fn charge_or_zero(&self) -> Balance

Returns how much balance is charged or 0 in case of a refund.

pub fn is_zero(&self) -> bool

impl<Balance> StorageDeposit<Balance>where
    Balance: Saturating + Ord + Copy,

pub fn saturating_add(&self, rhs: &Self) -> Self

This is essentially a saturating signed add.

pub fn saturating_sub(&self, rhs: &Self) -> Self

This is essentially a saturating signed sub.

pub fn available(&self, limit: &Balance) -> Balance

If the amount of deposit (this type) is constrained by a limit this calculates how much balance (if any) is still available from this limit.

Note

In case of a refund the return value can be larger than limit.

Trait Implementations

impl<Balance: Clone> Clone for StorageDeposit<Balance>

fn clone(&self) -> StorageDeposit<Balance>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Balance> Debug for StorageDeposit<Balance>where
    Balance: Debug,

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

Formats the value using the given formatter.

impl<Balance> Decode for StorageDeposit<Balance>where
    Balance: Decode,
    Balance: Decode,
    Balance: Decode,
    Balance: Decode,

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>where
    I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<Balance: Zero> Default for StorageDeposit<Balance>

fn default() -> Self

Returns the “default value” for a type.

impl<Balance> Encode for StorageDeposit<Balance>where
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<Balance: Ord> Ord for StorageDeposit<Balance>

fn cmp(&self, other: &StorageDeposit<Balance>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<Balance: PartialEq> PartialEq<StorageDeposit<Balance>> for StorageDeposit<Balance>

fn eq(&self, other: &StorageDeposit<Balance>) -> 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<Balance: PartialOrd> PartialOrd<StorageDeposit<Balance>> for StorageDeposit<Balance>

fn partial_cmp(&self, other: &StorageDeposit<Balance>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Balance> TypeInfo for StorageDeposit<Balance>where
    Balance: TypeInfo + 'static,
    Balance: TypeInfo + 'static,
    Balance: TypeInfo + 'static,

type Identity = StorageDeposit<Balance>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<Balance> EncodeLike<StorageDeposit<Balance>> for StorageDeposit<Balance>where
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,

impl<Balance: Eq> Eq for StorageDeposit<Balance>

impl<Balance> StructuralEq for StorageDeposit<Balance>

impl<Balance> StructuralPartialEq for StorageDeposit<Balance>