Struct money2::Money

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

An amount of Currency.

To find out how much the amount would be in another Currency, use exchange.

See also

• Money::new, for how to create Money when an amount does not already exist.

Fields

amount: Decimal

The amount of Currency that this Money represents.

currency: Currency

The Currency that this Money is in.

Implementations

impl Money

pub fn checked_add(self, rhs: Self) -> Option<Self>

Returns Some if rhs is the same Currency and doesn’t over/underflow.

Examples

use money2::{Currency, Money};

let a = Money::new(20_00, 2, Currency::Usd);

assert_eq!(a.checked_add(Money::new(1, 0, Currency::Eur)), None);
assert_eq!(
  a.checked_add(Money::new(5, 0, Currency::Usd)),
  Some(Money::new(25, 0, Currency::Usd))
);

pub fn checked_div(self, rhs: Self) -> Option<Self>

Returns Some if rhs is the same Currency and doesn’t over/underflow.

Examples

use money2::{Currency, Money};

let a = Money::new(20_00, 2, Currency::Usd);

assert_eq!(a.checked_div(Money::new(1, 0, Currency::Eur)), None);
assert_eq!(
  a.checked_div(Money::new(2, 0, Currency::Usd)),
  Some(Money::new(10, 0, Currency::Usd))
);

pub fn checked_mul(self, rhs: Self) -> Option<Self>

Returns Some if rhs is the same Currency and doesn’t over/underflow.

Examples

use money2::{Currency, Money};

let a = Money::new(20_00, 2, Currency::Usd);

assert_eq!(a.checked_mul(Money::new(1, 0, Currency::Eur)), None);
assert_eq!(
  a.checked_mul(Money::new(2, 0, Currency::Usd)),
  Some(Money::new(40, 0, Currency::Usd))
);

pub fn checked_rem(self, rhs: Self) -> Option<Self>

Returns Some if rhs is the same Currency and doesn’t over/underflow.

Examples

use money2::{Currency, Money};

let a = Money::new(20_00, 2, Currency::Usd);

assert_eq!(a.checked_rem(Money::new(1, 0, Currency::Eur)), None);
assert_eq!(
  a.checked_rem(Money::new(3, 0, Currency::Usd)),
  Some(Money::new(2, 0, Currency::Usd))
);

pub fn checked_sub(self, rhs: Self) -> Option<Self>

Returns Some if rhs is the same Currency and doesn’t over/underflow.

Examples

use money2::{Currency, Money};

let a = Money::new(20_00, 2, Currency::Usd);

assert_eq!(a.checked_sub(Money::new(1, 0, Currency::Eur)), None);
assert_eq!(
  a.checked_sub(Money::new(5, 0, Currency::Usd)),
  Some(Money::new(15, 0, Currency::Usd))
);

pub fn new(amount: i64, decimal_places: u32, currency: Currency) -> Self

Create new Money.

Examples

use money2::{Currency, Decimal, Money};

let literal = "20.00 USD";
let money = Money::new(20_00, 2, Currency::Usd);

assert_eq!(Money::try_from(literal).unwrap(), money);
assert_eq!(money.to_string(), literal);

Trait Implementations

impl Add for Money

fn add(self, rhs: Self) -> Self::Output

Panics

• If this currency and the rhs’s currency are not the same.
• When [Decimal::add] does.

See also

• Add::add

Examples

use money2::{Currency, Money};

assert_eq!(
  Money::new(10, 0, Currency::Eur) + Money::new(0_50, 2, Currency::Eur),
  Money::new(10_50, 2, Currency::Eur)
);

let _ = Money::new(10, 0, Currency::Eur) + Money::new(0_50, 2, Currency::Usd);

type Output = Money

The resulting type after applying the + operator.

impl AddAssign for Money

fn add_assign(&mut self, rhs: Self)

Panics

• When Money::add does.

See also

• AddAssign::add_assign

Examples

use money2::{Currency, Money};

let mut foo = Money::new(10, 0, Currency::Eur);
foo += Money::new(0_50, 2, Currency::Eur);
assert_eq!(foo, Money::new(10_50, 2, Currency::Eur));

foo += Money::new(0_50, 2, Currency::Usd);

impl Clone for Money

fn clone(&self) -> Money

Returns a copy 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 Default for Money

fn default() -> Money

Returns the “default value” for a type.

impl Display for Money

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

Formats the value using the given formatter.

impl Div for Money

fn div(self, rhs: Self) -> Self::Output

Panics

• If this currency and the operand’s currency are not the same.
• When [Decimal::div] does.

See also

• Div::div

Examples

use money2::{Currency, Money};

assert_eq!(
  Money::new(10, 0, Currency::Eur) / Money::new(2, 0, Currency::Eur),
  Money::new(5, 0, Currency::Eur)
);

let _ = Money::new(10, 0, Currency::Eur) / Money::new(2, 0, Currency::Usd);

type Output = Money

The resulting type after applying the / operator.

impl DivAssign for Money

fn div_assign(&mut self, rhs: Self)

Panics

• When Money::div does.

See also

• DivAssign::div_assign

Examples

use money2::{Currency, Money};

let mut foo = Money::new(10, 0, Currency::Eur);
foo /= Money::new(2, 0, Currency::Eur);
assert_eq!(foo, Money::new(5, 0, Currency::Eur));

foo /= Money::new(2, 0, Currency::Usd);

impl Exchange for Money

fn exchange_mut(&mut self, currency: Currency, rates: &ExchangeRates)

The result will be rounded to two decimal places.

See also

• Exchange::exchange_mut

fn exchange(self, currency: Currency, rates: &ExchangeRates) -> Selfwhere Self: Sized,

Exchange some quantity into another currency using rates. Derived from the exchange_mut implementation.

impl FromStr for Money

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

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

fn mul(self, rhs: Self) -> Self::Output

Panics

• If this currency and the operand’s currency are not the same.
• When [Decimal::mul] does.

See also

• Mul::mul

Examples

use money2::{Currency, Money};

assert_eq!(
  Money::new(10, 0, Currency::Eur) * Money::new(2, 0, Currency::Eur),
  Money::new(20, 0, Currency::Eur)
);

let _ = Money::new(10, 0, Currency::Eur) * Money::new(2, 0, Currency::Usd);

type Output = Money

The resulting type after applying the * operator.

impl MulAssign for Money

fn mul_assign(&mut self, rhs: Self)

Panics

• When Money::mul does.

See also

• MulAssign::mul_assign

Examples

use money2::{Currency, Money};

let mut foo = Money::new(10, 0, Currency::Eur);
foo *= Money::new(2, 0, Currency::Eur);
assert_eq!(foo, Money::new(20, 0, Currency::Eur));

foo *= Money::new(2, 0, Currency::Usd);

impl Ord for Money

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Money

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Money

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Rem for Money

fn rem(self, rhs: Self) -> Self::Output

Panics

• If this currency and the operand’s currency are not the same.
• When [Decimal::rem] does.

See also

• Rem::rem

Examples

use money2::{Currency, Money};

assert_eq!(
  Money::new(10, 0, Currency::Eur) % Money::new(3, 0, Currency::Eur),
  Money::new(1, 0, Currency::Eur)
);

let _ = Money::new(10, 0, Currency::Eur) % Money::new(3, 0, Currency::Usd);

type Output = Money

The resulting type after applying the % operator.

impl RemAssign for Money

fn rem_assign(&mut self, rhs: Self)

Panics

• When Money::rem does.

See also

• RemAssign::rem_assign

Examples

use money2::{Currency, Money};

let mut foo = Money::new(10, 0, Currency::Eur);
foo %= Money::new(3, 0, Currency::Eur);
assert_eq!(foo, Money::new(1, 0, Currency::Eur));

foo %= Money::new(3, 0, Currency::Usd);

impl Sub for Money

fn sub(self, rhs: Self) -> Self::Output

Panics

• If this currency and the operand’s currency are not the same.
• When [Decimal::sub] does.

See also

• Sub::sub

Examples

use money2::{Currency, Money};

assert_eq!(
  Money::new(10, 0, Currency::Eur) - Money::new(2, 0, Currency::Eur),
  Money::new(8, 0, Currency::Eur)
);

let _ = Money::new(10, 0, Currency::Eur) - Money::new(2, 0, Currency::Usd);

type Output = Money

The resulting type after applying the - operator.

impl SubAssign for Money

fn sub_assign(&mut self, rhs: Self)

Panics

• When Money::sub does.

See also

• SubAssign::sub_assign

Examples

use money2::{Currency, Money};

let mut foo = Money::new(10, 0, Currency::Eur);
foo -= Money::new(2, 0, Currency::Eur);
assert_eq!(foo, Money::new(8, 0, Currency::Eur));

foo -= Money::new(2, 0, Currency::Usd);

impl TryFrom<&str> for Money

type Error = <Money as FromStr>::Err

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Money

impl Eq for Money

impl StructuralEq for Money

impl StructuralPartialEq for Money