Struct common::prelude::BalanceUnit

pub struct BalanceUnit { /* private fields */ }

BalanceUnit wraps Balance and provides proper math operations between divisible & non-divisible balances that have different precision.

Implementations

impl BalanceUnit

pub fn new(balance: Balance, is_divisible: bool) -> Self

pub fn divisible(balance: Balance) -> Self

pub fn indivisible(balance: Balance) -> Self

pub fn copy_divisibility(&self, balance: Balance) -> Self

pub fn balance(&self) -> &Balance

pub fn set(&mut self, value: Balance)

pub fn is_divisible(&self) -> bool

pub fn pow(&self, x: u32) -> Result<Self, ArithmeticError>

pub fn sqrt(&self) -> Result<Self, ArithmeticError>

Trait Implementations

impl Add<BalanceUnit> for BalanceUnit

type Output = BalanceUnit

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<BalanceUnit> for BalanceUnit

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl CheckedAdd for BalanceUnit

fn checked_add(&self, rhs: &Self) -> Option<Self>

Adds two numbers, checking for overflow. If overflow happens, None is returned.

impl CheckedDiv for BalanceUnit

fn checked_div(&self, rhs: &Self) -> Option<Self>

Divides two numbers, checking for underflow, overflow and division by zero. If any of that happens, None is returned.

impl CheckedMul for BalanceUnit

fn checked_mul(&self, rhs: &Self) -> Option<Self>

Multiplies two numbers, checking for underflow or overflow. If underflow or overflow happens, None is returned.

impl CheckedSub for BalanceUnit

fn checked_sub(&self, rhs: &Self) -> Option<Self>

Subtracts two numbers, checking for underflow. If underflow happens, None is returned.

impl Clone for BalanceUnit

fn clone(&self) -> BalanceUnit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BalanceUnit

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

Formats the value using the given formatter.

impl Decode for BalanceUnit

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

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

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 Default for BalanceUnit

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BalanceUnit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BalanceUnit

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

Formats the value using the given formatter.

impl Div<BalanceUnit> for BalanceUnit

type Output = BalanceUnit

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl DivAssign<BalanceUnit> for BalanceUnit

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl Encode for BalanceUnit

fn size_hint(&self) -> usize

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

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

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

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 From<u128> for BalanceUnit

fn from(balance: Balance) -> Self

Converts to this type from the input type.

impl MaxEncodedLen for BalanceUnit

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl Mul<BalanceUnit> for BalanceUnit

type Output = BalanceUnit

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl MulAssign<BalanceUnit> for BalanceUnit

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Ord for BalanceUnit

fn cmp(&self, other: &Self) -> 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 PartialEq<BalanceUnit> for BalanceUnit

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

fn partial_cmp(&self, other: &Self) -> 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 Saturating for BalanceUnit

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

Saturating addition. Compute self + rhs, saturating at the numeric bounds instead of overflowing.

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

Saturating subtraction. Compute self - rhs, saturating at the numeric bounds instead of overflowing.

fn saturating_mul(self, rhs: Self) -> Self

Saturating multiply. Compute self * rhs, saturating at the numeric bounds instead of overflowing.

fn saturating_pow(self, exp: usize) -> Self

Saturating exponentiation. Compute self.pow(exp), saturating at the numeric bounds instead of overflowing.

impl Serialize for BalanceUnit

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<BalanceUnit> for BalanceUnit

type Output = BalanceUnit

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign<BalanceUnit> for BalanceUnit

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TypeInfo for BalanceUnit

type Identity = BalanceUnit

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Zero for BalanceUnit

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Copy for BalanceUnit

impl EncodeLike<BalanceUnit> for BalanceUnit

impl Eq for BalanceUnit

impl StructuralEq for BalanceUnit

impl StructuralPartialEq for BalanceUnit