Struct cosmwasm_std::Decimal256
source · [−]pub struct Decimal256(_);
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
sourceimpl Decimal256
impl Decimal256
pub const MAX: Self
sourcepub fn from_atomics(
atomics: impl Into<Uint256>,
decimal_places: u32
) -> Result<Self, Decimal256RangeExceeded>
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);
sourcepub fn from_ratio(
numerator: impl Into<Uint256>,
denominator: impl Into<Uint256>
) -> Self
pub fn from_ratio(
numerator: impl Into<Uint256>,
denominator: impl Into<Uint256>
) -> Self
Returns the ratio (numerator / denominator) as a Decimal256
pub fn is_zero(&self) -> bool
sourcepub fn atomics(&self) -> Uint256
pub 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));
sourcepub fn decimal_places(&self) -> u32
pub 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()
.
Trait Implementations
sourceimpl Add<&'_ Decimal256> for Decimal256
impl Add<&'_ Decimal256> for Decimal256
type Output = Self
type Output = Self
The resulting type after applying the +
operator.
sourcefn add(self, other: &Decimal256) -> Self
fn add(self, other: &Decimal256) -> Self
Performs the +
operation. Read more
sourceimpl Add<Decimal256> for Decimal256
impl Add<Decimal256> for Decimal256
sourceimpl Clone for Decimal256
impl Clone for Decimal256
sourcefn clone(&self) -> Decimal256
fn clone(&self) -> Decimal256
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for Decimal256
impl Debug for Decimal256
sourceimpl Default for Decimal256
impl Default for Decimal256
sourcefn default() -> Decimal256
fn default() -> Decimal256
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for Decimal256
impl<'de> Deserialize<'de> for Decimal256
Deserializes as a base64 string
sourcefn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Display for Decimal256
impl Display for Decimal256
sourceimpl Div<Uint256> for Decimal256
impl Div<Uint256> for Decimal256
sourceimpl DivAssign<Uint256> for Decimal256
impl DivAssign<Uint256> for Decimal256
sourcefn div_assign(&mut self, rhs: Uint256)
fn div_assign(&mut self, rhs: Uint256)
Performs the /=
operation. Read more
sourceimpl Fraction<Uint256> for Decimal256
impl Fraction<Uint256> for Decimal256
sourceimpl FromStr for Decimal256
impl FromStr for Decimal256
sourceimpl JsonSchema for Decimal256
impl JsonSchema for Decimal256
sourcefn schema_name() -> String
fn schema_name() -> String
The name of the generated JSON Schema. Read more
sourcefn json_schema(gen: &mut SchemaGenerator) -> Schema
fn json_schema(gen: &mut SchemaGenerator) -> Schema
Generates a JSON Schema for this type. Read more
sourcefn is_referenceable() -> bool
fn is_referenceable() -> bool
Whether JSON Schemas generated for this type should be re-used where possible using the $ref
keyword. Read more
sourceimpl Mul<Decimal256> for Decimal256
impl Mul<Decimal256> for Decimal256
sourceimpl Mul<Decimal256> for Uint256
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).
sourceimpl Mul<Uint256> for Decimal256
impl Mul<Uint256> for Decimal256
sourceimpl Ord for Decimal256
impl Ord for Decimal256
sourceimpl PartialEq<Decimal256> for Decimal256
impl PartialEq<Decimal256> for Decimal256
sourcefn eq(&self, other: &Decimal256) -> bool
fn eq(&self, other: &Decimal256) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &Decimal256) -> bool
fn ne(&self, other: &Decimal256) -> bool
This method tests for !=
.
sourceimpl PartialOrd<Decimal256> for Decimal256
impl PartialOrd<Decimal256> for Decimal256
sourcefn partial_cmp(&self, other: &Decimal256) -> Option<Ordering>
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 · sourcefn lt(&self, other: &Rhs) -> bool
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 · sourcefn le(&self, other: &Rhs) -> bool
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
sourceimpl Serialize for Decimal256
impl Serialize for Decimal256
Serializes as a decimal string
sourceimpl Sub<Decimal256> for Decimal256
impl Sub<Decimal256> for Decimal256
sourceimpl<A> Sum<A> for Decimal256 where
Self: Add<A, Output = Self>,
impl<A> Sum<A> for Decimal256 where
Self: Add<A, Output = Self>,
impl Copy for Decimal256
impl Eq for Decimal256
impl StructuralEq for Decimal256
impl StructuralPartialEq for Decimal256
Auto Trait Implementations
impl RefUnwindSafe for Decimal256
impl Send for Decimal256
impl Sync for Decimal256
impl Unpin for Decimal256
impl UnwindSafe for Decimal256
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more