Struct Money 

pub struct Money { /* private fields */ }

An amount in one currency, counted in that currency’s minor unit.

Implementations

impl Money

pub const fn from_minor_units(minor_units: i64, currency: Currency) -> Self

Builds an amount from a count of minor units — 1050 for 10.50 TRY.

pub fn parse(value: &str, currency: Currency) -> Result<Self, MoneyError>

Reads a plain decimal string such as "10.50".

pub const fn minor_units(self) -> i64

The amount as a count of minor units.

pub const fn currency(self) -> Currency

The currency the amount is in.

pub fn require_positive(self) -> Result<Self, MoneyError>

Fails unless the amount is greater than zero.

pub fn checked_add(self, other: Self) -> Result<Self, MoneyError>

Adds another amount in the same currency.

Fails on a currency mismatch, and on the overflow that would otherwise wrap a total round to a negative one.

pub fn checked_sub(self, other: Self) -> Result<Self, MoneyError>

Subtracts another amount in the same currency.

The result may be negative, because a ledger needs it to be: an over-refund is a number somebody has to see, not one to clamp away. Money::require_positive is what refuses it where it must be refused.

pub fn checked_mul(self, count: u32) -> Result<Self, MoneyError>

Multiplies by a count — a unit price by how many were bought.

Fails on the overflow that would otherwise wrap a line total round to a negative one.

pub const fn is_zero(self) -> bool

Whether the amount is exactly zero.

pub fn to_decimal_string(self) -> String

Renders the amount as a plain decimal string, without the currency code.

This is the form providers that take a decimal amount expect: 10.50, never 10.5 and never 1.05e1.

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

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

Formats the value using the given formatter.

impl Eq for Money

impl PartialEq for Money

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Money

Orders two amounts, and refuses to order two currencies.

partial_cmp answers None across currencies, because ten lira and ten dollars have no order. Deriving Ord would invent one out of the declaration order of Currency, which is how a comparison quietly starts answering a question nobody asked.

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