Struct steel_cent::currency::Currency

pub struct Currency { /* fields omitted */ }

A monetary currency with text and numeric codes and a standard number of decimal places, as per ISO 4217.

Three-letter currency codes are encoded in a u16, which is how this type can be small and Copy.

assert_eq!(4, std::mem::size_of::<Currency>());

Methods

impl Currency

pub fn new(code: &str, numeric_code: u16, decimal_places: u8) -> Self

Create a currency w/ the given 3-character code, 0-999 numeric code, and 0-8 decimal places. Panics if any arg violates those constraints. This function has no connection to the global currency maps used by lookup functions, so creating a custom currency won't cause it to show up in look-ups.

pub fn code(&self) -> String

assert_eq!("AUD", AUD.code());
assert_eq!("CAD", CAD.code());
assert_eq!("CHF", CHF.code());
assert_eq!("EUR", EUR.code());
assert_eq!("GBP", GBP.code());
assert_eq!("JPY", JPY.code());
assert_eq!("USD", USD.code());
assert_eq!("XTS", Currency::new("XTS", 999, 2).code());

pub fn numeric_code(&self) -> u16

assert_eq!(840, USD.numeric_code());
assert_eq!(392, JPY.numeric_code());

pub fn decimal_places(&self) -> u8

assert_eq!(2, USD.decimal_places());
assert_eq!(0, JPY.decimal_places());

pub fn major_to_minor(&self, major: i64) -> i64

Converts a "major" amount to a "minor" amount in this currency.

assert_eq!(100, USD.major_to_minor(1));
assert_eq!(100, JPY.major_to_minor(100))

pub fn major_to_minor_i32(&self, major: i32) -> i32

assert_eq!(100, USD.major_to_minor_i32(1));
assert_eq!(100, JPY.major_to_minor_i32(100))

pub fn major_part(&self, minor_amount: i64) -> i64

Returns the major part of a minor amount.

assert_eq!(12, USD.major_part(1234));
assert_eq!(1234, JPY.major_part(1234));

pub fn major_part_i32(&self, minor_amount: i32) -> i32

assert_eq!(12, USD.major_part_i32(1234));
assert_eq!(1234, JPY.major_part_i32(1234));

pub fn minor_part(&self, minor_amount: i64) -> i64

Returns the minor part of a minor amount.

assert_eq!(34, USD.minor_part(1234));
assert_eq!(0, JPY.minor_part(1234));

pub fn minor_part_i32(&self, minor_amount: i32) -> i32

assert_eq!(34, USD.minor_part_i32(1234));
assert_eq!(0, JPY.minor_part_i32(1234));

Trait Implementations

impl Clone for Currency

fn clone(&self) -> Currency

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Currency

impl Eq for Currency

impl PartialEq<Currency> for Currency

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

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

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

This method tests for !=.

impl Debug for Currency

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

Formats the value using the given formatter.

impl Hash for Currency

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, 

Feeds a slice of this type into the given [Hasher].