Struct DynamicDecimal 

pub struct DynamicDecimal { /* private fields */ }

Decimal real number with 38 digits of precision and dynamic scale.

This type is primarily meant as a serialized form of Fixed that does not require parameterization. Any Fixed can be converted into DynamicDecimal and then converted back into any other Fixed, possibly with a different precision and scale, without loss of precision (beyond that inherent in change of scale, if any).

Representation

The number is represented as an i128 significand and a u8 scale, that together express the value significand * 10**-scale.

Invariants

These invariants on significand and scale ensure that the value is in canonical form:

• If significand != 0 && scale != 0, then significand must not be a multiple of 10.

• If significand != 0 && scale == 0, then significand may be a multiple of 10. (This is a “denormalized” representation with fewer digits of precision than other forms.)

• If significand == 0, then scale must be zero.

Arithmetic

There are various arithmetic traits implemented for DynamicDecimal, but they are intended for limited uses; in particular, these functions will panic for overflows.

Implementations

impl DynamicDecimal

pub const MAX: Self

The largest DynamicDecimal value (i128::MAX).

pub const MIN: Self

The smallest DynamicDecimal value (i128::MIN).

pub const ZERO: Self

0 as DynamicDecimal.

pub const ONE: Self

1 as DynamicDecimal.

pub const fn new(sig: i128, exponent: u8) -> Self

Constructs a new DynamicDecimal with value sig * 10**-exponent.

pub const fn significand(&self) -> i128

Returns the canonical significand.

pub const fn exponent(&self) -> u8

Returns the canonical scale.

pub fn trunc(&self) -> Self

Truncates the value to an integer by discarding digits after decimal point

pub fn trunc_digits(&self, digits: u8) -> Self

Returns this value, truncated toward zero at digits after the decimal point.

pub fn floor(&self) -> Self

Floor of the value

pub const fn is_negative(self) -> bool

True if value is negative

pub const fn abs(self) -> Self

The absolute value

Trait Implementations

impl Add for DynamicDecimal

type Output = DynamicDecimal

The resulting type after applying the + operator.

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

Performs the + operation.

impl CheckedDiv for DynamicDecimal

fn checked_div(&self, other: &DynamicDecimal) -> Option<DynamicDecimal>

Divides two numbers, checking for underflow, overflow and division by zero. If any of that happens, None is returned.

impl Clone for DynamicDecimal

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DynamicDecimal

impl Debug for DynamicDecimal

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

Formats the value using the given formatter.

impl Default for DynamicDecimal

fn default() -> Self

Returns the “default value” for a type.

impl Display for DynamicDecimal

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

Formats the value using the given formatter.

impl Div for DynamicDecimal

type Output = DynamicDecimal

The resulting type after applying the / operator.

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

Performs the / operation.

impl Eq for DynamicDecimal

impl From<DynamicDecimal> for i128

fn from(value: DynamicDecimal) -> Self

Convert from Fixed to integer, rounding toward zero (the same semantics as Rust casts from float to integer).

impl From<DynamicDecimal> for f64

fn from(value: DynamicDecimal) -> Self

Converts to this type from the input type.

impl From<DynamicDecimal> for f32

fn from(value: DynamicDecimal) -> Self

Converts to this type from the input type.

impl<const P: usize, const S: usize> From<Fixed<P, S>> for DynamicDecimal

fn from(value: Fixed<P, S>) -> Self

Encodes value, for later deserialization into a new Fixed with possibly a different precision and scale.

impl From<i8> for DynamicDecimal

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<i16> for DynamicDecimal

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for DynamicDecimal

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for DynamicDecimal

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i128> for DynamicDecimal

fn from(value: i128) -> Self

Converts to this type from the input type.

impl From<isize> for DynamicDecimal

fn from(value: isize) -> Self

Converts to this type from the input type.

impl From<u8> for DynamicDecimal

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<u16> for DynamicDecimal

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for DynamicDecimal

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for DynamicDecimal

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<usize> for DynamicDecimal

fn from(value: usize) -> Self

Converts to this type from the input type.

impl FromStr for DynamicDecimal

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

Parses s as DynamicDecimal.

This accepts the same forms as f64::from_str, except that it rejects infinities and NaNs (which Fixed does not support), as well as out-of-range values. Rounds overprecise values to the nearest representable value, rounding halfway values to even.

type Err = ParseDecimalError

The associated error which can be returned from parsing.

impl Hash for DynamicDecimal

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul for DynamicDecimal

type Output = DynamicDecimal

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for DynamicDecimal

type Output = DynamicDecimal

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for DynamicDecimal

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for DynamicDecimal

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for DynamicDecimal

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Rem for DynamicDecimal

type Output = DynamicDecimal

The resulting type after applying the % operator.

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

Performs the % operation.

impl StructuralPartialEq for DynamicDecimal

impl Sub for DynamicDecimal

type Output = DynamicDecimal

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const P: usize, const S: usize> TryFrom<DynamicDecimal> for Fixed<P, S>

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

Deserializes DynamicDecimal into Fixed. If successful, returns the original value from before serialization. If S < value.exponent, then some trailing decimals are lost, by rounding toward zero. Returns an error` if the value is out of range for this type.

type Error = OutOfRange

The type returned in the event of a conversion error.

impl TryFrom<DynamicDecimal> for i64

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

Convert from Fixed to integer, rounding toward zero (the same semantics as Rust casts from float to integer).

type Error = OutOfRange

The type returned in the event of a conversion error.

impl TryFrom<DynamicDecimal> for i32

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

Convert from Fixed to integer, rounding toward zero (the same semantics as Rust casts from float to integer).

type Error = OutOfRange

The type returned in the event of a conversion error.

impl TryFrom<DynamicDecimal> for i16

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

Convert from Fixed to integer, rounding toward zero (the same semantics as Rust casts from float to integer).

type Error = OutOfRange

The type returned in the event of a conversion error.

impl TryFrom<DynamicDecimal> for i8

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

Convert from Fixed to integer, rounding toward zero (the same semantics as Rust casts from float to integer).

type Error = OutOfRange

The type returned in the event of a conversion error.

impl TryFrom<DynamicDecimal> for isize

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

Convert from Fixed to integer, rounding toward zero (the same semantics as Rust casts from float to integer).

type Error = OutOfRange

The type returned in the event of a conversion error.

impl TryFrom<DynamicDecimal> for u128

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

Convert from Fixed to integer, rounding toward zero (the same semantics as Rust casts from float to integer).

Because this rounds toward zero, negative values greater than -1 will convert to 0 instead of an out-of-range error.

type Error = OutOfRange

The type returned in the event of a conversion error.

impl TryFrom<DynamicDecimal> for u64

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

Convert from Fixed to integer, rounding toward zero (the same semantics as Rust casts from float to integer).

Because this rounds toward zero, negative values greater than -1 will convert to 0 instead of an out-of-range error.

type Error = OutOfRange

The type returned in the event of a conversion error.

impl TryFrom<DynamicDecimal> for u32

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

Convert from Fixed to integer, rounding toward zero (the same semantics as Rust casts from float to integer).

Because this rounds toward zero, negative values greater than -1 will convert to 0 instead of an out-of-range error.

type Error = OutOfRange

The type returned in the event of a conversion error.

impl TryFrom<DynamicDecimal> for u16

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

Convert from Fixed to integer, rounding toward zero (the same semantics as Rust casts from float to integer).

Because this rounds toward zero, negative values greater than -1 will convert to 0 instead of an out-of-range error.

type Error = OutOfRange

The type returned in the event of a conversion error.

impl TryFrom<DynamicDecimal> for u8

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

Convert from Fixed to integer, rounding toward zero (the same semantics as Rust casts from float to integer).

Because this rounds toward zero, negative values greater than -1 will convert to 0 instead of an out-of-range error.

type Error = OutOfRange

The type returned in the event of a conversion error.

impl TryFrom<DynamicDecimal> for usize

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

Convert from Fixed to integer, rounding toward zero (the same semantics as Rust casts from float to integer).

Because this rounds toward zero, negative values greater than -1 will convert to 0 instead of an out-of-range error.

type Error = OutOfRange

The type returned in the event of a conversion error.

impl TryFrom<f64> for DynamicDecimal

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

Convert value to DynamicDecimal, reporting an error if value is out of range.

type Error = OutOfRange

The type returned in the event of a conversion error.

impl TryFrom<u128> for DynamicDecimal

type Error = OutOfRange

The type returned in the event of a conversion error.

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

Performs the conversion.