Struct cosmwasm_std::Decimal

pub struct Decimal(_);

A fixed-point decimal value with 18 fractional digits, i.e. Decimal(1_000_000_000_000_000_000) == 1.0

The greatest possible value that can be represented is 340282366920938463463.374607431768211455 (which is (2^128 - 1) / 10^18)

Implementations

impl Decimal

pub const MAX: Self = Self(Uint128::MAX)

pub const fn new(value: Uint128) -> Self

Creates a Decimal(value) This is equivalent to Decimal::from_atomics(value, 18) but usable in a const context.

pub const fn raw(value: u128) -> Self

Creates a Decimal(Uint128(value)) This is equivalent to Decimal::from_atomics(value, 18) but usable in a const context.

pub const fn one() -> Self

Create a 1.0 Decimal

pub const fn zero() -> Self

Create a 0.0 Decimal

pub fn percent(x: u64) -> Self

Convert x% into Decimal

pub fn permille(x: u64) -> Self

Convert permille (x/1000) into Decimal

pub fn from_atomics(
    atomics: impl Into<Uint128>,
    decimal_places: u32
) -> Result<Self, DecimalRangeExceeded>

Creates a decimal from a number of atomic units and the number of decimal places. The inputs will be converted internally to form a decimal with 18 decimal places. So the input 123 and 2 will create the decimal 1.23.

Using 18 decimal places is slightly more efficient than other values as no internal conversion is necessary.

Examples

let a = Decimal::from_atomics(Uint128::new(1234), 3).unwrap();
assert_eq!(a.to_string(), "1.234");

let a = Decimal::from_atomics(1234u128, 0).unwrap();
assert_eq!(a.to_string(), "1234");

let a = Decimal::from_atomics(1u64, 18).unwrap();
assert_eq!(a.to_string(), "0.000000000000000001");

pub fn from_ratio(
    numerator: impl Into<Uint128>,
    denominator: impl Into<Uint128>
) -> Self

Returns the ratio (numerator / denominator) as a Decimal

pub fn checked_from_ratio(
    numerator: impl Into<Uint128>,
    denominator: impl Into<Uint128>
) -> Result<Self, CheckedFromRatioError>

Returns the ratio (numerator / denominator) as a Decimal

pub const fn is_zero(&self) -> bool

pub const fn atomics(&self) -> Uint128

A decimal is an integer of atomic units plus a number that specifies the position of the decimal dot. So any decimal can be expressed as two numbers.

Examples

// Value with whole and fractional part
let a = Decimal::from_str("1.234").unwrap();
assert_eq!(a.decimal_places(), 18);
assert_eq!(a.atomics(), Uint128::new(1234000000000000000));

// Smallest possible value
let b = Decimal::from_str("0.000000000000000001").unwrap();
assert_eq!(b.decimal_places(), 18);
assert_eq!(b.atomics(), Uint128::new(1));

pub const fn decimal_places(&self) -> u32

The number of decimal places. This is a constant value for now but this could potentially change as the type evolves.

See also Decimal::atomics().

pub fn checked_mul(self, other: Self) -> Result<Self, OverflowError>

Multiplies one Decimal by another, returning an OverflowError if an overflow occurred.

pub fn checked_pow(self, exp: u32) -> Result<Self, OverflowError>

Raises a value to the power of exp, returning an OverflowError if an overflow occurred.

pub fn sqrt(&self) -> Self

Returns the approximate square root as a Decimal.

This should not overflow or panic.

Trait Implementations

impl Add<&'_ Decimal> for Decimal

type Output = <Decimal as Add<Decimal>>::Output

The resulting type after applying the + operator.

fn add(self, other: &Decimal) -> <Decimal as Add<Decimal>>::Output

Performs the + operation.

impl Add<&'_ Decimal> for &Decimal

type Output = <Decimal as Add<Decimal>>::Output

The resulting type after applying the + operator.

fn add(self, other: &Decimal) -> <Decimal as Add<Decimal>>::Output

Performs the + operation.

impl Add<Decimal> for Decimal

type Output = Decimal

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl<'a> Add<Decimal> for &'a Decimal

type Output = <Decimal as Add<Decimal>>::Output

The resulting type after applying the + operator.

fn add(self, other: Decimal) -> <Decimal as Add<Decimal>>::Output

Performs the + operation.

impl AddAssign<&'_ Decimal> for Decimal

fn add_assign(&mut self, other: &Decimal)

Performs the += operation.

impl AddAssign<Decimal> for Decimal

fn add_assign(&mut self, rhs: Decimal)

Performs the += operation.

impl Clone for Decimal

fn clone(&self) -> Decimal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Decimal

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

Formats the value using the given formatter.

impl Default for Decimal

fn default() -> Decimal

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Decimal

Deserializes as a base64 string

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

Deserialize this value from the given Serde deserializer.

impl Display for Decimal

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

Formats the value using the given formatter.

impl Div<&'_ Decimal> for Decimal

type Output = <Decimal as Div<Decimal>>::Output

The resulting type after applying the / operator.

fn div(self, other: &Decimal) -> <Decimal as Div<Decimal>>::Output

Performs the / operation.

impl Div<&'_ Decimal> for &Decimal

type Output = <Decimal as Div<Decimal>>::Output

The resulting type after applying the / operator.

fn div(self, other: &Decimal) -> <Decimal as Div<Decimal>>::Output

Performs the / operation.

impl Div<Decimal> for Decimal

type Output = Decimal

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self

Performs the / operation.

impl<'a> Div<Decimal> for &'a Decimal

type Output = <Decimal as Div<Decimal>>::Output

The resulting type after applying the / operator.

fn div(self, other: Decimal) -> <Decimal as Div<Decimal>>::Output

Performs the / operation.

impl Div<Uint128> for Decimal

type Output = Decimal

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<&'_ Decimal> for Decimal

fn div_assign(&mut self, other: &Decimal)

Performs the /= operation.

impl DivAssign<Decimal> for Decimal

fn div_assign(&mut self, rhs: Decimal)

Performs the /= operation.

impl DivAssign<Uint128> for Decimal

fn div_assign(&mut self, rhs: Uint128)

Performs the /= operation.

impl Fraction<Uint128> for Decimal

fn inv(&self) -> Option<Self>

Returns the multiplicative inverse 1/d for decimal d.

If d is zero, none is returned.

fn numerator(&self) -> Uint128

Returns the numerator p

fn denominator(&self) -> Uint128

Returns the denominator q

impl FromStr for Decimal

fn from_str(input: &str) -> Result<Self, Self::Err>

Converts the decimal string to a Decimal Possible inputs: “1.23”, “1”, “000012”, “1.123000000” Disallowed: “”, “.23”

This never performs any kind of rounding. More than DECIMAL_PLACES fractional digits, even zeros, result in an error.

type Err = StdError

The associated error which can be returned from parsing.

impl JsonSchema for Decimal

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Mul<&'_ Decimal> for Decimal

type Output = <Decimal as Mul<Decimal>>::Output

The resulting type after applying the * operator.

fn mul(self, other: &Decimal) -> <Decimal as Mul<Decimal>>::Output

Performs the * operation.

impl Mul<&'_ Decimal> for &Decimal

type Output = <Decimal as Mul<Decimal>>::Output

The resulting type after applying the * operator.

fn mul(self, other: &Decimal) -> <Decimal as Mul<Decimal>>::Output

Performs the * operation.

impl Mul<Decimal> for Decimal

type Output = Decimal

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl<'a> Mul<Decimal> for &'a Decimal

type Output = <Decimal as Mul<Decimal>>::Output

The resulting type after applying the * operator.

fn mul(self, other: Decimal) -> <Decimal as Mul<Decimal>>::Output

Performs the * operation.

impl Mul<Decimal> for Uint128

Both du and ud with d: Decimal and u: Uint128 returns an Uint128. There is no specific reason for this decision other than the initial use cases we have. If you need a Decimal result for the same calculation, use Decimal(du) or Decimal(ud).

type Output = Uint128

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Uint128> for Decimal

type Output = Uint128

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&'_ Decimal> for Decimal

fn mul_assign(&mut self, other: &Decimal)

Performs the *= operation.

impl MulAssign<Decimal> for Decimal

fn mul_assign(&mut self, rhs: Decimal)

Performs the *= operation.

impl Ord for Decimal

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Decimal> for Decimal

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

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

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

This method tests for !=.

impl PartialOrd<Decimal> for Decimal

fn partial_cmp(&self, other: &Decimal) -> 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 Serialize for Decimal

Serializes as a decimal string

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

Serialize this value into the given Serde serializer.

impl Sub<&'_ Decimal> for Decimal

type Output = <Decimal as Sub<Decimal>>::Output

The resulting type after applying the - operator.

fn sub(self, other: &Decimal) -> <Decimal as Sub<Decimal>>::Output

Performs the - operation.

impl Sub<&'_ Decimal> for &Decimal

type Output = <Decimal as Sub<Decimal>>::Output

The resulting type after applying the - operator.

fn sub(self, other: &Decimal) -> <Decimal as Sub<Decimal>>::Output

Performs the - operation.

impl Sub<Decimal> for Decimal

type Output = Decimal

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl<'a> Sub<Decimal> for &'a Decimal

type Output = <Decimal as Sub<Decimal>>::Output

The resulting type after applying the - operator.

fn sub(self, other: Decimal) -> <Decimal as Sub<Decimal>>::Output

Performs the - operation.

impl SubAssign<&'_ Decimal> for Decimal

fn sub_assign(&mut self, other: &Decimal)

Performs the -= operation.

impl SubAssign<Decimal> for Decimal

fn sub_assign(&mut self, rhs: Decimal)

Performs the -= operation.

impl<A> Sum<A> for Decimal where
    Self: Add<A, Output = Self>, 

fn sum<I: Iterator<Item = A>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Decimal

impl Eq for Decimal

impl StructuralEq for Decimal

impl StructuralPartialEq for Decimal