Skip to main content

Decimal

Struct Decimal 

Source
pub struct Decimal { /* private fields */ }
Expand description

An exact base-10 fixed-point number: an integer coefficient divided by a power of ten. The value is coefficient · 10^(−scale), so 19.99 is coefficient = 1999, scale = 2. Money lives here — 0.1 + 0.2 is exactly 0.3, never the 0.30000000000000004 of a binary float, and a long ledger of sums never drifts.

+, , × are exact (multiplication adds the scales); ÷ and Decimal::rescale round under an explicit RoundingMode because base-10 division need not terminate. Equality and ordering are by value (1.0 == 1.00 == 1); scale is only a display hint. The coefficient is a BigInt, so the value is unbounded and exact — the i128 fast path is the documented performance follow-up.

Implementations§

Source§

impl Decimal

Source

pub fn from_bigint(coeff: BigInt) -> Decimal

The integer coeff at scale 0.

Source

pub fn from_i64(x: i64) -> Decimal

Source

pub fn from_coeff_scale(coeff: BigInt, scale: u32) -> Decimal

Construct directly from a coefficient and scale (value = coeff / 10^scale).

Source

pub fn zero() -> Decimal

Source

pub fn one() -> Decimal

Source

pub fn scale(&self) -> u32

Source

pub fn coefficient(&self) -> &BigInt

Source

pub fn is_zero(&self) -> bool

Source

pub fn is_negative(&self) -> bool

Source

pub fn negated(&self) -> Decimal

Source

pub fn abs(&self) -> Decimal

Source

pub fn to_rational(&self) -> Rational

Exact view as a Rational (coeff / 10^scale) — lossless, the bridge that keeps Decimal inside the exact tower.

Source

pub fn from_rational( value: &Rational, scale: u32, mode: RoundingMode, ) -> Decimal

The fixed-point value nearest value at the given scale, rounded under mode.

Source

pub fn rescale(&self, scale: u32, mode: RoundingMode) -> Decimal

Restate at a different scale. Widening appends zeros (exact); narrowing drops digits and rounds under mode.

Source

pub fn add(&self, other: &Decimal) -> Decimal

Source

pub fn sub(&self, other: &Decimal) -> Decimal

Source

pub fn mul(&self, other: &Decimal) -> Decimal

Exact product: coefficients multiply, scales add.

Source

pub fn div( &self, other: &Decimal, scale: u32, mode: RoundingMode, ) -> Option<Decimal>

Quotient rounded to scale under mode. None when other == 0 — base-10 division need not terminate, so the caller names the precision it wants.

Source

pub fn to_le_bytes(&self) -> (bool, Vec<u8>, u32)

Sign + little-endian coefficient bytes + scale — the wire form (the inverse of Decimal::from_le_bytes). Reuses BigInt’s exact byte serialization.

Source

pub fn from_le_bytes(negative: bool, bytes: &[u8], scale: u32) -> Decimal

Source

pub fn parse(s: &str) -> Option<Decimal>

Parse plain decimal notation: optional sign, optional integer part, optional .fraction. "19.99", "-0.005", ".5", "5.", "42" all parse; the scale is the count of fractional digits. None on a non-digit or an empty value.

Trait Implementations§

Source§

impl Clone for Decimal

Source§

fn clone(&self) -> Decimal

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Decimal

Source§

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

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

impl Display for Decimal

Source§

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

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

impl From<BigInt> for Decimal

Source§

fn from(x: BigInt) -> Self

Converts to this type from the input type.
Source§

impl From<i64> for Decimal

Source§

fn from(x: i64) -> Self

Converts to this type from the input type.
Source§

impl Hash for Decimal

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Decimal

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

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

impl PartialEq for Decimal

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Decimal

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl Eq for Decimal

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where 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> ToOwned for T
where T: Clone,

Source§

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 T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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

Source§

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.