Struct Decimal 

pub struct Decimal { /* private fields */ }

An exact decimal value units / 10^9.

Implementations

impl Decimal

pub const ZERO: Decimal

Zero.

pub const fn from_units(units: i128) -> Decimal

The decimal units / 10^9.

pub const fn units(&self) -> i128

The raw unit count (value * 10^9).

pub const fn from_i64(v: i64) -> Decimal

The integer v. Always fits: |i64| * 10^9 < 2^127.

pub const fn is_negative(&self) -> bool

True when the value is strictly below zero.

pub fn parse(s: &str) -> Result<Decimal, DecimalError>

Parse -?(0|[1-9][0-9]*)(\.[0-9]{1,9})? exactly.

No whitespace, +, exponent, leading zero, bare or trailing . is accepted. Trailing fractional zeros are accepted (1.50 equals 1.5), and -0 equals zero. More than nine fractional digits is DecimalError::TooPrecise; a value outside the i128 unit range is DecimalError::OutOfRange.

pub fn to_canonical_string(&self) -> String

The canonical form: no trailing fractional zeros, no . when integral, never -0. Decimal::parse inverts it exactly.

pub fn checked_add(self, rhs: Decimal) -> Result<Decimal, ArithError>

Exact sum, or ArithError::Overflow.

pub fn checked_sub(self, rhs: Decimal) -> Result<Decimal, ArithError>

Exact difference, or ArithError::Overflow.

pub fn checked_mul( self, rhs: Decimal, rounding: Rounding, ) -> Result<Decimal, ArithError>

Product rounded to nine fractional digits.

Declared bound: the exact intermediate units_a * units_b must fit in i128; otherwise ArithError::Overflow, even if the rounded result would fit.

pub fn checked_div( self, rhs: Decimal, rounding: Rounding, ) -> Result<Decimal, ArithError>

Quotient rounded to nine fractional digits.

Declared bound: the intermediate units_a * 10^9 must fit in i128; otherwise ArithError::Overflow. A zero divisor is ArithError::DivisionByZero.

pub fn round_to_scale( self, scale: u32, rounding: Rounding, ) -> Result<Decimal, ArithError>

Round to scale fractional digits (0..=9); a larger scale is ArithError::InvalidScale. Rounding away from zero at the edge of the range is ArithError::Overflow.

pub fn to_f64_nearest(&self) -> f64

The f64 nearest to the exact value (correctly rounded by parsing the canonical string). Lossy by nature; never used for exact computation.

Trait Implementations

impl Clone for Decimal

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 Decimal

impl Debug for Decimal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Decimal

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

Accepts a JSON string only; a JSON number is refused.

impl Display for Decimal

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

Formats the value using the given formatter.

impl Eq for Decimal

impl Hash for Decimal

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 JsonSchema for Decimal

fn json_schema(_: &mut SchemaGenerator) -> Schema

A decimal string; the parser alone judges canonical form and bounds.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

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

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for Decimal

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 Decimal

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Decimal

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 Serialize for Decimal

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Decimal