Struct steel_cent::Money [−] [src]

pub struct Money {
    pub currency: Currency,
    // some fields omitted
}

A signed amount of money in a certain currency.

assert_eq!(16, std::mem::size_of::<Money>());Run

Examples

let price = Money::of_major_minor(USD, 19, 95);
let shipping_and_handling = Money::of_major(USD, 10);
let convenience_charge = Money::of_major(USD, 6);
let discount: f64 = 1.0 - 0.2; // 20% off
let discounted_price = price * discount;
let fees = shipping_and_handling + convenience_charge;
let total = discounted_price + fees;
println!("price: {:?}, discounted_price: {:?}", price, discounted_price);
assert_eq!(Money::of_minor(USD, 1596), discounted_price);
assert_eq!(Money::of_minor(USD, 3196), total);
assert_eq!((price * discount) + shipping_and_handling + convenience_charge, total);Run

Fields

currency: Currency

Methods

`impl Money`
[src]

`fn of_minor(currency: Currency, amount_minor: i64) -> Self`

Creates a Money from its "minor" unit (e.g. US cents to USD).

`fn of_major(currency: Currency, amount_major: i64) -> Self`

Creates a Money from its "major" unit (e.g. US dollars to USD).

`fn of_major_minor(currency: Currency, amount_major: i64, amount_minor: i64) -> Self`

`fn major_part(&self) -> i64`

`fn minor_part(&self) -> i64`

`fn min(currency: Currency) -> Money`

assert_eq!(Money::of_major_minor(USD, -92_233_720_368_547_758, -08), Money::min(USD));Run

`fn max(currency: Currency) -> Money`

assert_eq!(Money::of_major_minor(USD, 92_233_720_368_547_758, 07), Money::max(USD));Run

Trait Implementations

`impl Debug for Money`
[src]

`fn fmt(&self, __arg_0: &mut Formatter) -> Result`

Formats the value using the given formatter.

`impl PartialEq for Money`
[src]

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

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

`fn ne(&self, __arg_0: &Money) -> bool`

This method tests for !=.

`impl Eq for Money`
[src]

`impl Copy for Money`
[src]

`impl Clone for Money`
[src]

`fn clone(&self) -> Money`

Returns a copy of the value. Read more

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

Performs copy-assignment from source. Read more

`impl FormattableMoney for Money`
[src]

`fn unformatted_minor_amount(&self) -> String`

`fn currency(&self) -> Currency`

`impl Add for Money`
[src]

let one = Money::of_major(USD, 1);
assert_eq!(Money::of_major(USD, 2), one.clone() + one);Run

Attempting to add moneys of different currencies will panic.

Money::of_major(USD, 1) + Money::of_major(JPY, 1); // panics!Run

`type Output = Money`

The resulting type after applying the + operator

`fn add(self, other: Money) -> Money`

The method for the + operator

`impl<'b> Add<&'b Money> for Money`
[src]

let one = Money::of_major(USD, 1);
assert_eq!(Money::of_major(USD, 2), one.clone() + &one);Run

Attempting to add moneys of different currencies will panic.

Money::of_major(USD, 1) + &Money::of_major(JPY, 1); // panics!Run

`type Output = Money`

The resulting type after applying the + operator

`fn add(self, other: &'b Money) -> Money`

The method for the + operator

`impl<'a> Add<Money> for &'a Money`
[src]

let one = Money::of_major(USD, 1);
assert_eq!(Money::of_major(USD, 2), &one + one.clone());Run

Attempting to add moneys of different currencies will panic.

&Money::of_major(USD, 1) + Money::of_major(JPY, 1); // panics!Run

`type Output = Money`

The resulting type after applying the + operator

`fn add(self, other: Money) -> Money`

The method for the + operator

`impl<'a, 'b> Add<&'b Money> for &'a Money`
[src]

let one = Money::of_major(USD, 1);
assert_eq!(Money::of_major(USD, 2), &one + &one);Run

Attempting to add moneys of different currencies will panic.

&Money::of_major(USD, 1) + &Money::of_major(JPY, 1); // panics!Run

`type Output = Money`

The resulting type after applying the + operator

`fn add(self, other: &'b Money) -> Money`

The method for the + operator

`impl Sub for Money`
[src]

let one = Money::of_major(USD, 1);
assert_eq!(Money::of_major(USD, 0), one.clone() - one);Run

Attempting to subtract moneys of different currencies will panic.

Money::of_major(USD, 1) - Money::of_major(JPY, 1); // panics!Run

`type Output = Money`

The resulting type after applying the - operator

`fn sub(self, other: Money) -> Money`

The method for the - operator

`impl<'b> Sub<&'b Money> for Money`
[src]

let one = Money::of_major(USD, 1);
assert_eq!(Money::of_major(USD, 0), one.clone() - &one);Run

Attempting to subtract moneys of different currencies will panic.

Money::of_major(USD, 1) - &Money::of_major(JPY, 1); // panics!Run

`type Output = Money`

The resulting type after applying the - operator

`fn sub(self, other: &'b Money) -> Money`

The method for the - operator

`impl<'a> Sub<Money> for &'a Money`
[src]

let one = Money::of_major(USD, 1);
assert_eq!(Money::of_major(USD, 0), &one - one.clone());Run

Attempting to subtract moneys of different currencies will panic.

&Money::of_major(USD, 1) - Money::of_major(JPY, 1); // panics!Run

`type Output = Money`

The resulting type after applying the - operator

`fn sub(self, other: Money) -> Money`

The method for the - operator

`impl<'a, 'b> Sub<&'b Money> for &'a Money`
[src]

let one = Money::of_major(USD, 1);
assert_eq!(Money::of_major(USD, 0), &one - &one);Run

Attempting to subtract moneys of different currencies will panic.

&Money::of_major(USD, 1) - &Money::of_major(JPY, 1); // panics!Run

`type Output = Money`

The resulting type after applying the - operator