Struct orml_utilities::fixed_u128::FixedU128

pub struct FixedU128(_);

An unsigned fixed point number. Can hold any value in the range [0, 340_282_366_920_938_463_464] with fixed point accuracy of 10 ** 18.

Implementations

impl FixedU128

pub fn from_natural(int: u128) -> Self

Create self from a natural number.

Note that this might be lossy.

pub const fn accuracy() -> u128

Accuracy of FixedU128.

pub fn from_parts(parts: u128) -> Self

Raw constructor. Equal to parts / DIV.

pub fn from_rational<N: UniqueSaturatedInto<u128>>(n: N, d: N) -> Self

Creates self from a rational number. Equal to n/d.

Note that this might be lossy.

pub fn deconstruct(self) -> u128

Consume self and return the inner raw u128 value.

Note this is a low level function, as the returned value is represented with accuracy.

pub fn recip(&self) -> Option<Self>

Takes the reciprocal(inverse) of FixedU128, 1/x

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

Checked add. Same semantic to num_traits::CheckedAdd.

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

Checked sub. Same semantic to num_traits::CheckedSub.

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

Checked mul. Same semantic to num_traits::CheckedMul.

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

Checked div. Same semantic to num_traits::CheckedDiv.

pub fn checked_mul_int<N>(&self, other: &N) -> Option<N> where
    N: Copy + TryFrom<u128> + TryInto<u128>, 

Checked mul for int type N.

pub fn saturating_mul_int<N>(&self, other: &N) -> N where
    N: Copy + TryFrom<u128> + TryInto<u128> + Bounded, 

Checked mul for int type N.

pub fn checked_div_int<N>(&self, other: &N) -> Option<N> where
    N: Copy + TryFrom<u128> + TryInto<u128>, 

Checked div for int type N.

pub fn zero() -> Self

pub fn is_zero(&self) -> bool

Trait Implementations

impl Bounded for FixedU128

fn max_value() -> Self

returns the largest finite number this type can represent

fn min_value() -> Self

returns the smallest finite number this type can represent

impl Clone for FixedU128

fn clone(&self) -> FixedU128

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompactAs for FixedU128

type As = u128

A compact-encodable type that should be used as the encoding.

fn encode_as(&self) -> &u128

Returns the encodable type.

fn decode_from(x: u128) -> FixedU128

Create Self from the decodable type.

impl Copy for FixedU128

impl Debug for FixedU128

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

Formats the value using the given formatter.

impl Decode for FixedU128

fn decode<DecIn: Input>(input: &mut DecIn) -> Result<Self, Error>

Attempt to deserialise the value from input.

impl Default for FixedU128

fn default() -> FixedU128

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for FixedU128

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

Deserialize this value from the given Serde deserializer.

impl Encode for FixedU128

fn encode_to<EncOut: Output>(&self, dest: &mut EncOut)

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

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

Convert self to an owned vector.

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

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

fn size_hint(&self) -> usize

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

impl EncodeLike<FixedU128> for FixedU128

impl Eq for FixedU128

impl From<Compact<FixedU128>> for FixedU128

fn from(x: Compact<FixedU128>) -> FixedU128

Performs the conversion.

impl From<Perbill> for FixedU128

fn from(val: Perbill) -> Self

Performs the conversion.

impl From<Percent> for FixedU128

fn from(val: Percent) -> Self

Performs the conversion.

impl From<Permill> for FixedU128

fn from(val: Permill) -> Self

Performs the conversion.

impl From<Perquintill> for FixedU128

fn from(val: Perquintill) -> Self

Performs the conversion.

impl Ord for FixedU128

fn cmp(&self, other: &FixedU128) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<FixedU128> for FixedU128

fn eq(&self, other: &FixedU128) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FixedU128) -> bool

This method tests for !=.

impl PartialOrd<FixedU128> for FixedU128

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

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

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

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

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

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

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

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

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

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

impl Saturating for FixedU128

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

Saturating addition. 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_sub(self, rhs: Self) -> Self

Saturating subtraction. 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 FixedU128

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

Serialize this value into the given Serde serializer.

impl StructuralEq for FixedU128

impl StructuralPartialEq for FixedU128