Struct CurrencyCode 

pub struct CurrencyCode(/* private fields */);

ISO 4217 currency code.

Implementations

impl CurrencyCode

pub fn new(code: impl AsRef<str>) -> Result<Self, PaymentError>

Parses and validates an ISO 4217-style currency code.

Errors

Returns an error when the code is not exactly three ASCII letters.

pub fn as_str(&self) -> &str

Returns the normalized currency code.

pub fn minor_unit_exponent(&self) -> u8

Returns the ISO 4217 minor-unit exponent used by common providers.

pub fn minor_unit_factor(&self) -> i64

Returns the multiplier between major and minor units.

pub fn format_minor_units(&self, minor: i64) -> String

Formats a minor-unit amount as a provider decimal amount string.

pub fn minor_units_to_major_integer( &self, minor: i64, ) -> Result<i64, PaymentError>

Converts a minor-unit amount into an integer major-unit amount.

Errors

Returns an error when the minor amount cannot be represented as a whole major unit.

pub fn major_integer_to_minor_units( &self, major: i64, ) -> Result<i64, PaymentError>

Converts an integer major-unit amount into minor units.

Errors

Returns an error when the multiplication overflows.

Trait Implementations

impl AsRef<str> for CurrencyCode

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CurrencyCode

fn clone(&self) -> CurrencyCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CurrencyCode

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

Formats the value using the given formatter.

impl Hash for CurrencyCode

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 CurrencyCode

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

Tests for self and other values to be equal, and is used by ==.

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 CurrencyCode

impl StructuralPartialEq for CurrencyCode