Struct fadroma::prelude::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§
source§impl Decimal256
impl Decimal256
sourcepub const DECIMAL_PLACES: u32 = 18u32
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.
sourcepub const MAX: Decimal256 = Self(Uint256::MAX)
pub const MAX: Decimal256 = Self(Uint256::MAX)
The largest value that can be represented by this decimal type.
sourcepub const MIN: Decimal256 = Self(Uint256::MIN)
pub const MIN: Decimal256 = Self(Uint256::MIN)
The smallest value that can be represented by this decimal type.
sourcepub const fn new(value: Uint256) -> Decimal256
pub const fn new(value: Uint256) -> Decimal256
Creates a Decimal256 from Uint256
This is equivalent to Decimal256::from_atomics(value, 18)
but usable in a const context.
sourcepub const fn raw(value: u128) -> Decimal256
pub const fn raw(value: u128) -> Decimal256
Creates a Decimal256 from u128
This is equivalent to Decimal256::from_atomics(value, 18)
but usable in a const context.
sourcepub const fn one() -> Decimal256
pub const fn one() -> Decimal256
Create a 1.0 Decimal256
sourcepub const fn zero() -> Decimal256
pub const fn zero() -> Decimal256
Create a 0.0 Decimal256
sourcepub fn percent(x: u64) -> Decimal256
pub fn percent(x: u64) -> Decimal256
Convert x% into Decimal256
sourcepub fn permille(x: u64) -> Decimal256
pub fn permille(x: u64) -> Decimal256
Convert permille (x/1000) into Decimal256
sourcepub fn from_atomics(
atomics: impl Into<Uint256>,
decimal_places: u32
) -> Result<Decimal256, Decimal256RangeExceeded>
pub fn from_atomics( atomics: impl Into<Uint256>, decimal_places: u32 ) -> Result<Decimal256, 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>
) -> Decimal256
pub fn from_ratio( numerator: impl Into<Uint256>, denominator: impl Into<Uint256> ) -> Decimal256
Returns the ratio (numerator / denominator) as a Decimal256
sourcepub fn checked_from_ratio(
numerator: impl Into<Uint256>,
denominator: impl Into<Uint256>
) -> Result<Decimal256, CheckedFromRatioError>
pub fn checked_from_ratio( numerator: impl Into<Uint256>, denominator: impl Into<Uint256> ) -> Result<Decimal256, CheckedFromRatioError>
Returns the ratio (numerator / denominator) as a Decimal256
pub const fn is_zero(&self) -> bool
sourcepub const fn atomics(&self) -> Uint256
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));
sourcepub const fn decimal_places(&self) -> u32
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()
.
sourcepub fn floor(&self) -> Decimal256
pub fn floor(&self) -> Decimal256
Rounds value down after decimal places.
sourcepub fn ceil(&self) -> Decimal256
pub fn ceil(&self) -> Decimal256
Rounds value up after decimal places. Panics on overflow.
sourcepub fn checked_ceil(&self) -> Result<Decimal256, RoundUpOverflowError>
pub fn checked_ceil(&self) -> Result<Decimal256, RoundUpOverflowError>
Rounds value up after decimal places. Returns OverflowError on overflow.
pub fn checked_add(self, other: Decimal256) -> Result<Decimal256, OverflowError>
pub fn checked_sub(self, other: Decimal256) -> Result<Decimal256, OverflowError>
sourcepub fn checked_mul(self, other: Decimal256) -> Result<Decimal256, OverflowError>
pub fn checked_mul(self, other: Decimal256) -> Result<Decimal256, OverflowError>
Multiplies one Decimal256
by another, returning an OverflowError
if an overflow occurred.
sourcepub fn pow(self, exp: u32) -> Decimal256
pub fn pow(self, exp: u32) -> Decimal256
Raises a value to the power of exp
, panics if an overflow occurred.
sourcepub fn checked_pow(self, exp: u32) -> Result<Decimal256, OverflowError>
pub fn checked_pow(self, exp: u32) -> Result<Decimal256, OverflowError>
Raises a value to the power of exp
, returning an OverflowError
if an overflow occurred.
pub fn checked_div( self, other: Decimal256 ) -> Result<Decimal256, CheckedFromRatioError>
pub fn checked_rem( self, other: Decimal256 ) -> Result<Decimal256, DivideByZeroError>
sourcepub fn sqrt(&self) -> Decimal256
pub fn sqrt(&self) -> Decimal256
Returns the approximate square root as a Decimal256.
This should not overflow or panic.
pub fn abs_diff(self, other: Decimal256) -> Decimal256
pub fn saturating_add(self, other: Decimal256) -> Decimal256
pub fn saturating_sub(self, other: Decimal256) -> Decimal256
pub fn saturating_mul(self, other: Decimal256) -> Decimal256
pub fn saturating_pow(self, exp: u32) -> Decimal256
Trait Implementations§
source§impl Add<&Decimal256> for &Decimal256
impl Add<&Decimal256> for &Decimal256
§type Output = <Decimal256 as Add<Decimal256>>::Output
type Output = <Decimal256 as Add<Decimal256>>::Output
+
operator.source§fn add(self, other: &Decimal256) -> <Decimal256 as Add<Decimal256>>::Output
fn add(self, other: &Decimal256) -> <Decimal256 as Add<Decimal256>>::Output
+
operation. Read moresource§impl Add<&Decimal256> for Decimal256
impl Add<&Decimal256> for Decimal256
§type Output = <Decimal256 as Add<Decimal256>>::Output
type Output = <Decimal256 as Add<Decimal256>>::Output
+
operator.source§fn add(self, other: &Decimal256) -> <Decimal256 as Add<Decimal256>>::Output
fn add(self, other: &Decimal256) -> <Decimal256 as Add<Decimal256>>::Output
+
operation. Read moresource§impl<'a> Add<Decimal256> for &'a Decimal256
impl<'a> Add<Decimal256> for &'a Decimal256
§type Output = <Decimal256 as Add<Decimal256>>::Output
type Output = <Decimal256 as Add<Decimal256>>::Output
+
operator.source§fn add(self, other: Decimal256) -> <Decimal256 as Add<Decimal256>>::Output
fn add(self, other: Decimal256) -> <Decimal256 as Add<Decimal256>>::Output
+
operation. Read moresource§impl Add<Decimal256> for Decimal256
impl Add<Decimal256> for Decimal256
§type Output = Decimal256
type Output = Decimal256
+
operator.source§fn add(self, other: Decimal256) -> Decimal256
fn add(self, other: Decimal256) -> Decimal256
+
operation. Read moresource§impl AddAssign<&Decimal256> for Decimal256
impl AddAssign<&Decimal256> for Decimal256
source§fn add_assign(&mut self, other: &Decimal256)
fn add_assign(&mut self, other: &Decimal256)
+=
operation. Read moresource§impl AddAssign<Decimal256> for Decimal256
impl AddAssign<Decimal256> for Decimal256
source§fn add_assign(&mut self, rhs: Decimal256)
fn add_assign(&mut self, rhs: Decimal256)
+=
operation. Read moresource§impl Canonize for Decimal256
impl Canonize for Decimal256
source§impl Clone for Decimal256
impl Clone for Decimal256
source§fn clone(&self) -> Decimal256
fn clone(&self) -> Decimal256
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for Decimal256
impl Debug for Decimal256
source§impl Default for Decimal256
impl Default for Decimal256
source§fn default() -> Decimal256
fn default() -> Decimal256
source§impl<'de> Deserialize<'de> for Decimal256
impl<'de> Deserialize<'de> for Decimal256
Deserializes as a base64 string
source§fn deserialize<D>(
deserializer: D
) -> Result<Decimal256, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>( deserializer: D ) -> Result<Decimal256, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,
source§impl Display for Decimal256
impl Display for Decimal256
source§impl Div<&Decimal256> for &Decimal256
impl Div<&Decimal256> for &Decimal256
§type Output = <Decimal256 as Div<Decimal256>>::Output
type Output = <Decimal256 as Div<Decimal256>>::Output
/
operator.source§fn div(self, other: &Decimal256) -> <Decimal256 as Div<Decimal256>>::Output
fn div(self, other: &Decimal256) -> <Decimal256 as Div<Decimal256>>::Output
/
operation. Read moresource§impl Div<&Decimal256> for Decimal256
impl Div<&Decimal256> for Decimal256
§type Output = <Decimal256 as Div<Decimal256>>::Output
type Output = <Decimal256 as Div<Decimal256>>::Output
/
operator.source§fn div(self, other: &Decimal256) -> <Decimal256 as Div<Decimal256>>::Output
fn div(self, other: &Decimal256) -> <Decimal256 as Div<Decimal256>>::Output
/
operation. Read moresource§impl<'a> Div<Decimal256> for &'a Decimal256
impl<'a> Div<Decimal256> for &'a Decimal256
§type Output = <Decimal256 as Div<Decimal256>>::Output
type Output = <Decimal256 as Div<Decimal256>>::Output
/
operator.source§fn div(self, other: Decimal256) -> <Decimal256 as Div<Decimal256>>::Output
fn div(self, other: Decimal256) -> <Decimal256 as Div<Decimal256>>::Output
/
operation. Read moresource§impl Div<Decimal256> for Decimal256
impl Div<Decimal256> for Decimal256
§type Output = Decimal256
type Output = Decimal256
/
operator.source§fn div(self, other: Decimal256) -> Decimal256
fn div(self, other: Decimal256) -> Decimal256
/
operation. Read moresource§impl Div<Uint256> for Decimal256
impl Div<Uint256> for Decimal256
source§impl DivAssign<&Decimal256> for Decimal256
impl DivAssign<&Decimal256> for Decimal256
source§fn div_assign(&mut self, other: &Decimal256)
fn div_assign(&mut self, other: &Decimal256)
/=
operation. Read moresource§impl DivAssign<Decimal256> for Decimal256
impl DivAssign<Decimal256> for Decimal256
source§fn div_assign(&mut self, rhs: Decimal256)
fn div_assign(&mut self, rhs: Decimal256)
/=
operation. Read moresource§impl DivAssign<Uint256> for Decimal256
impl DivAssign<Uint256> for Decimal256
source§fn div_assign(&mut self, rhs: Uint256)
fn div_assign(&mut self, rhs: Uint256)
/=
operation. Read moresource§impl FadromaDeserialize for Decimal256
impl FadromaDeserialize for Decimal256
source§fn from_bytes<'a>(de: &mut Deserializer<'a>) -> Result<Self>
fn from_bytes<'a>(de: &mut Deserializer<'a>) -> Result<Self>
Deserializer
.source§impl FadromaSerialize for Decimal256
impl FadromaSerialize for Decimal256
source§fn size_hint(&self) -> usize
fn size_hint(&self) -> usize
source§fn to_bytes(&self, ser: &mut Serializer) -> Result<()>
fn to_bytes(&self, ser: &mut Serializer) -> Result<()>
Serializer
.source§impl Fraction<Uint256> for Decimal256
impl Fraction<Uint256> for Decimal256
source§impl From<Decimal> for Decimal256
impl From<Decimal> for Decimal256
source§fn from(input: Decimal) -> Decimal256
fn from(input: Decimal) -> Decimal256
source§impl FromStr for Decimal256
impl FromStr for Decimal256
source§fn from_str(input: &str) -> Result<Decimal256, <Decimal256 as FromStr>::Err>
fn from_str(input: &str) -> Result<Decimal256, <Decimal256 as FromStr>::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.
source§impl Humanize for Decimal256
impl Humanize for Decimal256
source§impl JsonSchema for Decimal256
impl JsonSchema for Decimal256
source§fn schema_name() -> String
fn schema_name() -> String
source§fn json_schema(gen: &mut SchemaGenerator) -> Schema
fn json_schema(gen: &mut SchemaGenerator) -> Schema
source§fn is_referenceable() -> bool
fn is_referenceable() -> bool
$ref
keyword. Read moresource§impl Mul<&Decimal256> for &Decimal256
impl Mul<&Decimal256> for &Decimal256
§type Output = <Decimal256 as Mul<Decimal256>>::Output
type Output = <Decimal256 as Mul<Decimal256>>::Output
*
operator.source§fn mul(self, other: &Decimal256) -> <Decimal256 as Mul<Decimal256>>::Output
fn mul(self, other: &Decimal256) -> <Decimal256 as Mul<Decimal256>>::Output
*
operation. Read moresource§impl Mul<&Decimal256> for Decimal256
impl Mul<&Decimal256> for Decimal256
§type Output = <Decimal256 as Mul<Decimal256>>::Output
type Output = <Decimal256 as Mul<Decimal256>>::Output
*
operator.source§fn mul(self, other: &Decimal256) -> <Decimal256 as Mul<Decimal256>>::Output
fn mul(self, other: &Decimal256) -> <Decimal256 as Mul<Decimal256>>::Output
*
operation. Read moresource§impl<'a> Mul<Decimal256> for &'a Decimal256
impl<'a> Mul<Decimal256> for &'a Decimal256
§type Output = <Decimal256 as Mul<Decimal256>>::Output
type Output = <Decimal256 as Mul<Decimal256>>::Output
*
operator.source§fn mul(self, other: Decimal256) -> <Decimal256 as Mul<Decimal256>>::Output
fn mul(self, other: Decimal256) -> <Decimal256 as Mul<Decimal256>>::Output
*
operation. Read moresource§impl Mul<Decimal256> for Decimal256
impl Mul<Decimal256> for Decimal256
§type Output = Decimal256
type Output = Decimal256
*
operator.source§fn mul(self, other: Decimal256) -> Decimal256
fn mul(self, other: Decimal256) -> Decimal256
*
operation. Read moresource§impl 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).
source§impl Mul<Uint256> for Decimal256
impl Mul<Uint256> for Decimal256
source§impl MulAssign<&Decimal256> for Decimal256
impl MulAssign<&Decimal256> for Decimal256
source§fn mul_assign(&mut self, other: &Decimal256)
fn mul_assign(&mut self, other: &Decimal256)
*=
operation. Read moresource§impl MulAssign<Decimal256> for Decimal256
impl MulAssign<Decimal256> for Decimal256
source§fn mul_assign(&mut self, rhs: Decimal256)
fn mul_assign(&mut self, rhs: Decimal256)
*=
operation. Read moresource§impl Ord for Decimal256
impl Ord for Decimal256
source§fn cmp(&self, other: &Decimal256) -> Ordering
fn cmp(&self, other: &Decimal256) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<&Decimal256> for Decimal256
impl PartialEq<&Decimal256> for Decimal256
source§fn eq(&self, rhs: &&Decimal256) -> bool
fn eq(&self, rhs: &&Decimal256) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialEq<Decimal256> for &Decimal256
impl PartialEq<Decimal256> for &Decimal256
source§fn eq(&self, rhs: &Decimal256) -> bool
fn eq(&self, rhs: &Decimal256) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialEq<Decimal256> for Decimal256
impl PartialEq<Decimal256> for Decimal256
source§fn eq(&self, other: &Decimal256) -> bool
fn eq(&self, other: &Decimal256) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<Decimal256> for Decimal256
impl PartialOrd<Decimal256> for Decimal256
source§fn partial_cmp(&self, other: &Decimal256) -> Option<Ordering>
fn partial_cmp(&self, other: &Decimal256) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Rem<&Decimal256> for &Decimal256
impl Rem<&Decimal256> for &Decimal256
§type Output = <Decimal256 as Rem<Decimal256>>::Output
type Output = <Decimal256 as Rem<Decimal256>>::Output
%
operator.source§fn rem(self, other: &Decimal256) -> <Decimal256 as Rem<Decimal256>>::Output
fn rem(self, other: &Decimal256) -> <Decimal256 as Rem<Decimal256>>::Output
%
operation. Read moresource§impl Rem<&Decimal256> for Decimal256
impl Rem<&Decimal256> for Decimal256
§type Output = <Decimal256 as Rem<Decimal256>>::Output
type Output = <Decimal256 as Rem<Decimal256>>::Output
%
operator.source§fn rem(self, other: &Decimal256) -> <Decimal256 as Rem<Decimal256>>::Output
fn rem(self, other: &Decimal256) -> <Decimal256 as Rem<Decimal256>>::Output
%
operation. Read moresource§impl<'a> Rem<Decimal256> for &'a Decimal256
impl<'a> Rem<Decimal256> for &'a Decimal256
§type Output = <Decimal256 as Rem<Decimal256>>::Output
type Output = <Decimal256 as Rem<Decimal256>>::Output
%
operator.source§fn rem(self, other: Decimal256) -> <Decimal256 as Rem<Decimal256>>::Output
fn rem(self, other: Decimal256) -> <Decimal256 as Rem<Decimal256>>::Output
%
operation. Read moresource§impl Rem<Decimal256> for Decimal256
impl Rem<Decimal256> for Decimal256
source§fn rem(self, rhs: Decimal256) -> Decimal256
fn rem(self, rhs: Decimal256) -> Decimal256
Panics
This operation will panic if rhs
is zero
§type Output = Decimal256
type Output = Decimal256
%
operator.source§impl RemAssign<&Decimal256> for Decimal256
impl RemAssign<&Decimal256> for Decimal256
source§fn rem_assign(&mut self, other: &Decimal256)
fn rem_assign(&mut self, other: &Decimal256)
%=
operation. Read moresource§impl RemAssign<Decimal256> for Decimal256
impl RemAssign<Decimal256> for Decimal256
source§fn rem_assign(&mut self, rhs: Decimal256)
fn rem_assign(&mut self, rhs: Decimal256)
%=
operation. Read moresource§impl Serialize for Decimal256
impl Serialize for Decimal256
Serializes as a decimal string
source§fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where S: Serializer,
source§impl Sub<&Decimal256> for &Decimal256
impl Sub<&Decimal256> for &Decimal256
§type Output = <Decimal256 as Sub<Decimal256>>::Output
type Output = <Decimal256 as Sub<Decimal256>>::Output
-
operator.source§fn sub(self, other: &Decimal256) -> <Decimal256 as Sub<Decimal256>>::Output
fn sub(self, other: &Decimal256) -> <Decimal256 as Sub<Decimal256>>::Output
-
operation. Read moresource§impl Sub<&Decimal256> for Decimal256
impl Sub<&Decimal256> for Decimal256
§type Output = <Decimal256 as Sub<Decimal256>>::Output
type Output = <Decimal256 as Sub<Decimal256>>::Output
-
operator.source§fn sub(self, other: &Decimal256) -> <Decimal256 as Sub<Decimal256>>::Output
fn sub(self, other: &Decimal256) -> <Decimal256 as Sub<Decimal256>>::Output
-
operation. Read moresource§impl<'a> Sub<Decimal256> for &'a Decimal256
impl<'a> Sub<Decimal256> for &'a Decimal256
§type Output = <Decimal256 as Sub<Decimal256>>::Output
type Output = <Decimal256 as Sub<Decimal256>>::Output
-
operator.source§fn sub(self, other: Decimal256) -> <Decimal256 as Sub<Decimal256>>::Output
fn sub(self, other: Decimal256) -> <Decimal256 as Sub<Decimal256>>::Output
-
operation. Read moresource§impl Sub<Decimal256> for Decimal256
impl Sub<Decimal256> for Decimal256
§type Output = Decimal256
type Output = Decimal256
-
operator.source§fn sub(self, other: Decimal256) -> Decimal256
fn sub(self, other: Decimal256) -> Decimal256
-
operation. Read moresource§impl SubAssign<&Decimal256> for Decimal256
impl SubAssign<&Decimal256> for Decimal256
source§fn sub_assign(&mut self, other: &Decimal256)
fn sub_assign(&mut self, other: &Decimal256)
-=
operation. Read moresource§impl SubAssign<Decimal256> for Decimal256
impl SubAssign<Decimal256> for Decimal256
source§fn sub_assign(&mut self, rhs: Decimal256)
fn sub_assign(&mut self, rhs: Decimal256)
-=
operation. Read moresource§impl<A> Sum<A> for Decimal256where
Decimal256: Add<A, Output = Decimal256>,
impl<A> Sum<A> for Decimal256where Decimal256: Add<A, Output = Decimal256>,
source§fn sum<I>(iter: I) -> Decimal256where
I: Iterator<Item = A>,
fn sum<I>(iter: I) -> Decimal256where I: Iterator<Item = A>,
Self
from the elements by
“summing up” the items.