Struct Money 

pub struct Money {
    pub amount: Decimal,
    pub currency: Currency,
}

An exact monetary amount, quantised to its currency’s minor unit.

Fields

amount: Decimal

The amount, exact, at currency.scale fractional digits.

currency: Currency

Implementations

impl Money

pub fn of(amount: Decimal, currency: Currency) -> Money

Build money, quantising the amount to the currency’s minor unit with banker’s rounding — 5 USD is stored as 5.00, 19.999 USD rounds to 20.00, 100 JPY stays 100.

pub fn add(&self, other: &Money) -> Option<Money>

Sum of two amounts in the same currency; None across currencies (no common meaning).

pub fn sub(&self, other: &Money) -> Option<Money>

Difference of two amounts in the same currency; None across currencies.

pub fn scale_int(&self, k: i64) -> Money

Scale an amount by a plain integer (19.99 USD × 3 = 59.97 USD), re-quantised to the currency.

pub fn ratio(&self, other: &Money) -> Option<Rational>

The exact dimensionless ratio of two same-currency amounts (30 USD ÷ 10 USD = 3); None across currencies or when the divisor is zero.

Trait Implementations

impl Clone for Money

fn clone(&self) -> Money

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Money

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

Formats the value using the given formatter.

impl Display for Money

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

"19.99 USD" — the amount at the currency’s minor-unit scale, then the code.

impl Hash for Money

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 PartialEq for Money

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

Value equality: same currency and equal amount (5 USD == 5.00 USD, 5 USD ≠ 5 EUR).

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

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

impl Eq for Money