Struct Money 

pub struct Money { /* private fields */ }

A currency amount stored in Stripe’s smallest denomination.

Stripe never transmits a floating point amount, so Money keeps an integer minor-unit count plus the currency that determines how the value converts back to a major-unit decimal. Two USD is 200 minor units; two JPY is 2, because JPY has no minor unit.

Accessors are generated by #[derive(Getter)]. Both fields are public because callers persist the raw minor-unit count straight into Stripe’s amount parameter; currency_code pairs the two when a human-readable form is needed.

Implementations

impl Money

pub const fn zero(currency: Currency) -> Money

Build a zero amount in the given currency.

Arguments

• Currency - the currency of the zero amount.

Returns

• Self - a zero-valued amount.

pub const fn from_minor(amount: i64, currency: Currency) -> Money

Build an amount directly from a minor-unit value.

This is the constructor that matches the wire format: Stripe sends and accepts amount in the smallest denomination.

Arguments

• i64 - the amount in the currency’s smallest denomination.
• Currency - the currency the amount is denominated in.

Returns

• Self - the amount, unchanged.

pub const fn from_major(amount: i64, currency: Currency) -> Money

Build an amount from a major-unit value.

1_099 USD becomes 109_900 minor units; 1_099 JPY stays 1_099 because JPY has no minor unit.

Arguments

• i64 - the amount in major units.
• Currency - the currency the amount is denominated in.

Returns

• Self - the amount converted into minor units.

pub fn currency_code(&self) -> &'static str

Return the ISO 4217 code Stripe expects for this amount.

Returns

• &'static str - the three-letter uppercase currency code.

pub fn to_major(&self) -> Decimal

Return the amount converted back to major units.

Returns

• Decimal - the minor-unit count rescaled by the currency’s exponent, so 200 USD reads back as 2.00.

pub fn with_currency(&self, currency: Currency) -> Money

Return the same minor-unit count labelled with another currency.

Stripe never converts between currencies; this only rewrites the label and exists for presentation code, not for sending a charge.

Arguments

• Currency - the currency to relabel the amount with.

Returns

• Self - the same minor-unit count under a new currency.

pub fn is_negative(&self) -> bool

Return whether the amount is negative, which Stripe rejects.

Returns

• bool - true when the amount is below zero.

pub fn abs(&self) -> Money

Return the amount with any leading minus sign removed.

Returns

• Self - the absolute value of the amount.

pub fn checked_add(&self, other: Money) -> Result<Money, StripeParseError>

Return this amount plus another of the same currency.

Arguments

• Self - the amount to add.

Returns

• Result<Self, StripeParseError> - the sum, or an error when the currencies differ or the addition overflows i64.

impl Money

pub fn get_amount(&self) -> i64

pub fn get_currency(&self) -> Currency

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<(), Error>

Formats the value using the given formatter.

impl Display for Money

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

Render the amount as a decimal in major units.

Arguments

• &mut Formatter<'_> - the formatter to write the value into.

Returns

A Formatter writing the decimal amount and its currency code.

impl Eq for Money

impl Hash for Money

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Money

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

Equality operator ==.

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

Inequality operator !=.

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

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Money