# Struct cosmwasm_std::Decimal256

``pub struct Decimal256(/* private fields */);``
Expand description

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

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

## Implementations§

source§

### impl Decimal256

source

#### pub const DECIMAL_PLACES: u32 = 18u32

The number of decimal places. Since decimal types are fixed-point rather than floating-point, this is a constant.

source

#### pub const MAX: Self = _

The largest value that can be represented by this decimal type.

source

#### pub const MIN: Self = _

The smallest value that can be represented by this decimal type.

source

#### pub const fn new(value: Uint256) -> Self

Creates a Decimal256 from Uint256 This is equivalent to `Decimal256::from_atomics(value, 18)` but usable in a const context.

source

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

Creates a Decimal256 from u128 This is equivalent to `Decimal256::from_atomics(value, 18)` but usable in a const context.

source

#### pub const fn one() -> Self

Create a 1.0 Decimal256

source

#### pub const fn zero() -> Self

Create a 0.0 Decimal256

source

#### pub const fn percent(x: u64) -> Self

Convert x% into Decimal256

###### Examples
``````const HALF: Decimal256 = Decimal256::percent(50);

assert_eq!(HALF, Decimal256::from_str("0.5").unwrap());``````
source

#### pub const fn permille(x: u64) -> Self

Convert permille (x/1000) into Decimal256

###### Examples
``````const HALF: Decimal256 = Decimal256::permille(500);

assert_eq!(HALF, Decimal256::from_str("0.5").unwrap());``````
source

#### pub const fn bps(x: u64) -> Self

Convert basis points (x/10000) into Decimal256

###### Examples
``````const TWO_BPS: Decimal256 = Decimal256::bps(2);
const HALF: Decimal256 = Decimal256::bps(5000);

assert_eq!(TWO_BPS, Decimal256::from_str("0.0002").unwrap());
assert_eq!(HALF, Decimal256::from_str("0.5").unwrap());``````
source

#### pub fn from_atomics( atomics: impl Into<Uint256>, decimal_places: u32 ) -> Result<Self, Decimal256RangeExceeded>

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 = Decimal256::from_atomics(1234u64, 3).unwrap();
assert_eq!(a.to_string(), "1.234");

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

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

let a = Decimal256::from_atomics(Uint256::MAX, 18).unwrap();
assert_eq!(a, Decimal256::MAX);``````
source

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

Returns the ratio (numerator / denominator) as a Decimal256

source

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

Returns the ratio (numerator / denominator) as a Decimal256

source

source

#### pub const fn atomics(&self) -> Uint256

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 = Decimal256::from_str("1.234").unwrap();
assert_eq!(a.decimal_places(), 18);
assert_eq!(a.atomics(), Uint256::from(1234000000000000000u128));

// Smallest possible value
let b = Decimal256::from_str("0.000000000000000001").unwrap();
assert_eq!(b.decimal_places(), 18);
assert_eq!(b.atomics(), Uint256::from(1u128));``````
source

#### 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 `Decimal256::atomics()`.

source

#### pub fn floor(&self) -> Self

Rounds value down after decimal places.

source

#### pub fn ceil(&self) -> Self

Rounds value up after decimal places. Panics on overflow.

source

#### pub fn checked_ceil(&self) -> Result<Self, RoundUpOverflowError>

Rounds value up after decimal places. Returns OverflowError on overflow.

source

source

source

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

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

source

#### pub fn pow(self, exp: u32) -> Self

Raises a value to the power of `exp`, panics if an overflow occurred.

source

#### 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.

source

source

source

#### pub fn sqrt(&self) -> Self

Returns the approximate square root as a Decimal256.

This should not overflow or panic.

source

source

source

source

source

source

#### pub fn to_uint_floor(self) -> Uint256

Converts this decimal to an unsigned integer by truncating the fractional part, e.g. 22.5 becomes 22.

###### Examples
``````use core::str::FromStr;
use cosmwasm_std::{Decimal256, Uint256};

let d = Decimal256::from_str("12.345").unwrap();
assert_eq!(d.to_uint_floor(), Uint256::from(12u64));

let d = Decimal256::from_str("12.999").unwrap();
assert_eq!(d.to_uint_floor(), Uint256::from(12u64));

let d = Decimal256::from_str("75.0").unwrap();
assert_eq!(d.to_uint_floor(), Uint256::from(75u64));``````
source

#### pub fn to_uint_ceil(self) -> Uint256

Converts this decimal to an unsigned integer by rounting up to the next integer, e.g. 22.3 becomes 23.

###### Examples
``````use core::str::FromStr;
use cosmwasm_std::{Decimal256, Uint256};

let d = Decimal256::from_str("12.345").unwrap();
assert_eq!(d.to_uint_ceil(), Uint256::from(13u64));

let d = Decimal256::from_str("12.999").unwrap();
assert_eq!(d.to_uint_ceil(), Uint256::from(13u64));

let d = Decimal256::from_str("75.0").unwrap();
assert_eq!(d.to_uint_ceil(), Uint256::from(75u64));``````

## Trait Implementations§

source§

§

#### type Output = <Decimal256 as Add>::Output

The resulting type after applying the `+` operator.
source§

Performs the `+` operation. Read more
source§

§

#### type Output = <Decimal256 as Add>::Output

The resulting type after applying the `+` operator.
source§

Performs the `+` operation. Read more
source§

### impl<'a> Add<Decimal256> for &'a Decimal256

§

#### type Output = <Decimal256 as Add>::Output

The resulting type after applying the `+` operator.
source§

Performs the `+` operation. Read more
source§

§

#### type Output = Decimal256

The resulting type after applying the `+` operator.
source§

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

Performs the `+` operation. Read more
source§

source§

#### fn add_assign(&mut self, other: &Decimal256)

Performs the `+=` operation. Read more
source§

source§

#### fn add_assign(&mut self, rhs: Decimal256)

Performs the `+=` operation. Read more
source§

### impl Clone for Decimal256

source§

#### fn clone(&self) -> Decimal256

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for Decimal256

source§

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

Formats the value using the given formatter. Read more
source§

### impl Default for Decimal256

source§

#### fn default() -> Decimal256

Returns the “default value” for a type. Read more
source§

### impl<'de> Deserialize<'de> for Decimal256

Deserializes as a base64 string

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

### impl Display for Decimal256

source§

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

Formats the value using the given formatter. Read more
source§

### impl Div<&Decimal256> for &Decimal256

§

#### type Output = <Decimal256 as Div>::Output

The resulting type after applying the `/` operator.
source§

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

Performs the `/` operation. Read more
source§

### impl Div<&Decimal256> for Decimal256

§

#### type Output = <Decimal256 as Div>::Output

The resulting type after applying the `/` operator.
source§

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

Performs the `/` operation. Read more
source§

### impl<'a> Div<Decimal256> for &'a Decimal256

§

#### type Output = <Decimal256 as Div>::Output

The resulting type after applying the `/` operator.
source§

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

Performs the `/` operation. Read more
source§

### impl Div<Uint256> for Decimal256

§

#### type Output = Decimal256

The resulting type after applying the `/` operator.
source§

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

Performs the `/` operation. Read more
source§

### impl Div for Decimal256

§

#### type Output = Decimal256

The resulting type after applying the `/` operator.
source§

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

Performs the `/` operation. Read more
source§

### impl DivAssign<&Decimal256> for Decimal256

source§

#### fn div_assign(&mut self, other: &Decimal256)

Performs the `/=` operation. Read more
source§

### impl DivAssign<Uint256> for Decimal256

source§

#### fn div_assign(&mut self, rhs: Uint256)

Performs the `/=` operation. Read more
source§

### impl DivAssign for Decimal256

source§

#### fn div_assign(&mut self, rhs: Decimal256)

Performs the `/=` operation. Read more
source§

### impl Fraction<Uint256> for Decimal256

source§

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

Returns the multiplicative inverse `1/d` for decimal `d`.

If `d` is zero, none is returned.

source§

#### fn numerator(&self) -> Uint256

Returns the numerator `p`
source§

#### fn denominator(&self) -> Uint256

Returns the denominator `q`
source§

### impl From<Decimal> for Decimal256

source§

#### fn from(input: Decimal) -> Self

Converts to this type from the input type.
source§

### impl FromStr for Decimal256

source§

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

Converts the decimal string to a Decimal256 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.
source§

### impl JsonSchema for Decimal256

source§

#### fn schema_name() -> String

The name of the generated JSON Schema. Read more
source§

#### fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
source§

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

Generates a JSON Schema for this type. Read more
source§

#### fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the `\$ref` keyword. Read more
source§

### impl Mul<&Decimal256> for &Decimal256

§

#### type Output = <Decimal256 as Mul>::Output

The resulting type after applying the `*` operator.
source§

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

Performs the `*` operation. Read more
source§

### impl Mul<&Decimal256> for Decimal256

§

#### type Output = <Decimal256 as Mul>::Output

The resulting type after applying the `*` operator.
source§

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

Performs the `*` operation. Read more
source§

### impl<'a> Mul<Decimal256> for &'a Decimal256

§

#### type Output = <Decimal256 as Mul>::Output

The resulting type after applying the `*` operator.
source§

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

Performs the `*` operation. Read more
source§

### impl Mul<Decimal256> for Uint256

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

§

#### type Output = Uint256

The resulting type after applying the `*` operator.
source§

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

Performs the `*` operation. Read more
source§

### impl Mul<Uint256> for Decimal256

§

#### type Output = Uint256

The resulting type after applying the `*` operator.
source§

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

Performs the `*` operation. Read more
source§

### impl Mul for Decimal256

§

#### type Output = Decimal256

The resulting type after applying the `*` operator.
source§

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

Performs the `*` operation. Read more
source§

### impl MulAssign<&Decimal256> for Decimal256

source§

#### fn mul_assign(&mut self, other: &Decimal256)

Performs the `*=` operation. Read more
source§

### impl MulAssign for Decimal256

source§

#### fn mul_assign(&mut self, rhs: Self)

Performs the `*=` operation. Read more
source§

### impl Ord for Decimal256

source§

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

This method returns an `Ordering` between `self` and `other`. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

### impl PartialEq<&Decimal256> for Decimal256

source§

#### fn eq(&self, rhs: &&Decimal256) -> bool

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

#### 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.
source§

### impl<'a> PartialEq<Decimal256> for &'a Decimal256

source§

#### fn eq(&self, rhs: &Decimal256) -> bool

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

#### 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.
source§

### impl PartialEq for Decimal256

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

#### 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.
source§

### impl PartialOrd for Decimal256

source§

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

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 · source§

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

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 · source§

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

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

### impl Rem<&Decimal256> for &Decimal256

§

#### type Output = <Decimal256 as Rem>::Output

The resulting type after applying the `%` operator.
source§

#### fn rem(self, other: &Decimal256) -> <Decimal256 as Rem<Decimal256>>::Output

Performs the `%` operation. Read more
source§

### impl Rem<&Decimal256> for Decimal256

§

#### type Output = <Decimal256 as Rem>::Output

The resulting type after applying the `%` operator.
source§

#### fn rem(self, other: &Decimal256) -> <Decimal256 as Rem<Decimal256>>::Output

Performs the `%` operation. Read more
source§

### impl<'a> Rem<Decimal256> for &'a Decimal256

§

#### type Output = <Decimal256 as Rem>::Output

The resulting type after applying the `%` operator.
source§

#### fn rem(self, other: Decimal256) -> <Decimal256 as Rem<Decimal256>>::Output

Performs the `%` operation. Read more
source§

### impl Rem for Decimal256

source§

#### fn rem(self, rhs: Self) -> Self

##### Panics

This operation will panic if `rhs` is zero

§

#### type Output = Decimal256

The resulting type after applying the `%` operator.
source§

### impl RemAssign<&Decimal256> for Decimal256

source§

#### fn rem_assign(&mut self, other: &Decimal256)

Performs the `%=` operation. Read more
source§

### impl RemAssign for Decimal256

source§

#### fn rem_assign(&mut self, rhs: Decimal256)

Performs the `%=` operation. Read more
source§

### impl Serialize for Decimal256

Serializes as a decimal string

source§

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

Serialize this value into the given Serde serializer. Read more
source§

### impl Sub<&Decimal256> for &Decimal256

§

#### type Output = <Decimal256 as Sub>::Output

The resulting type after applying the `-` operator.
source§

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

Performs the `-` operation. Read more
source§

### impl Sub<&Decimal256> for Decimal256

§

#### type Output = <Decimal256 as Sub>::Output

The resulting type after applying the `-` operator.
source§

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

Performs the `-` operation. Read more
source§

### impl<'a> Sub<Decimal256> for &'a Decimal256

§

#### type Output = <Decimal256 as Sub>::Output

The resulting type after applying the `-` operator.
source§

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

Performs the `-` operation. Read more
source§

### impl Sub for Decimal256

§

#### type Output = Decimal256

The resulting type after applying the `-` operator.
source§

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

Performs the `-` operation. Read more
source§

### impl SubAssign<&Decimal256> for Decimal256

source§

#### fn sub_assign(&mut self, other: &Decimal256)

Performs the `-=` operation. Read more
source§

### impl SubAssign for Decimal256

source§

#### fn sub_assign(&mut self, rhs: Decimal256)

Performs the `-=` operation. Read more
source§

### impl<A> Sum<A> for Decimal256where Self: Add<A, Output = Self>,

source§

#### 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.
source§

### impl TryFrom<Decimal256> for Decimal

§

#### type Error = DecimalRangeExceeded

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

#### fn try_from(value: Decimal256) -> Result<Self, Self::Error>

Performs the conversion.
source§

### impl TryFrom<Decimal256> for SignedDecimal

§

#### type Error = SignedDecimalRangeExceeded

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

#### fn try_from(value: Decimal256) -> Result<Self, Self::Error>

Performs the conversion.
source§

### impl TryFrom<Decimal256> for SignedDecimal256

§

#### type Error = SignedDecimal256RangeExceeded

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

#### fn try_from(value: Decimal256) -> Result<Self, Self::Error>

Performs the conversion.
source§

### impl TryFrom<SignedDecimal> for Decimal256

§

#### type Error = Decimal256RangeExceeded

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

#### fn try_from(value: SignedDecimal) -> Result<Self, Self::Error>

Performs the conversion.
source§

### impl TryFrom<SignedDecimal256> for Decimal256

§

#### type Error = Decimal256RangeExceeded

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

#### fn try_from(value: SignedDecimal256) -> Result<Self, Self::Error>

Performs the conversion.
source§

source§

source§

source§

§

§

§

§

§

## Blanket Implementations§

source§

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

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<U> As for U

source§

#### fn as_<T>(self) -> Twhere T: CastFrom<U>,

Casts `self` to type `T`. The semantics of numeric casting with the `as` operator are followed, so `<T as As>::as_::<U>` can be used in the same way as `T as U` for numeric conversions. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

source§

source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere 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> Same for T

§

#### type Output = T

Should always be `Self`
source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T> ToString for Twhere T: Display + ?Sized,

source§

#### default fn to_string(&self) -> String

Converts the given value to a `String`. Read more
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### 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 Twhere U: TryFrom<T>,

§

#### 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.
source§

§

§

§

§