Struct Money 

pub struct Money {
    pub currency_code: String,
    pub units: i64,
    pub nanos: i32,
}

Available on crate feature money only.

Represents an amount of money with its currency type.

Fields

currency_code: String

The three-letter currency code defined in ISO 4217.

units: i64

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

nanos: i32

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

Implementations

impl Money

pub const fn total_nanos(&self) -> i128

Returns the total amount in nano units.

pub fn from_total_nanos( currency: impl Into<String>, total: i128, ) -> Result<Self, MoneyError>

Creates a new instance from a total amount of nanos and a currency code.

pub fn to_formatted_string(&self, symbol: &str, decimal_places: u32) -> String

Normalizes the Money amount and returns a string containing the currency symbol and the monetary amount with the specified amount of decimal places, while truncating the rest.

pub fn normalize(self) -> Result<Self, MoneyError>

Normalizes units and nanos. Fails in case of overflow.

pub fn new( currency_code: impl Into<String>, units: i64, nanos: i32, ) -> Result<Self, MoneyError>

Creates a new instance, if the normalization does not return errors like Overflow or Underflow.

pub fn to_rounded_imprecise_f64( &self, decimal_places: u32, ) -> Result<f64, MoneyError>

Converts the Money amount into a decimal (f64) representation, rounded to the specified number of decimal places.

decimal_places determines the precision of the rounding. For example:

• 0 rounds to the nearest whole unit.
• 2 rounds to two decimal places (e.g., for cents).

WARNING: The usage of f64 introduces floating-point precision issues. Do not use it for critical financial calculations.

pub fn as_imprecise_f64(&self) -> f64

Converts the Money amount into a decimal (f64) representation.

WARNING: The usage of f64 introduces floating-point precision issues. Do not use it for critical financial calculations.

pub fn from_imprecise_f64( currency_code: impl Into<String>, amount: f64, ) -> Result<Self, MoneyError>

Creates a new Money instance with the given currency code and decimal amount.

This is a convenience constructor that handles splitting a decimal value into units and nanos.

WARNING: The usage of f64 introduces floating-point precision issues. Do not use it for critical financial calculations.

pub fn try_add(&self, other: &Self) -> Result<Self, MoneyError>

Attempts to add another Money amount to this one, returning a new Money instance. Returns an error if currencies mismatch or if addition causes an overflow/underflow.

pub fn try_add_assign(&mut self, other: &Self) -> Result<(), MoneyError>

Attempts to add another Money amount to this one in place. Returns an error if currencies mismatch or if addition causes an overflow/underflow.

pub fn try_sub(&self, other: &Self) -> Result<Self, MoneyError>

Attempts to subtract another Money amount from this one, returning a new Money instance. Returns an error if currencies mismatch or if subtraction causes an overflow/underflow.

pub fn try_sub_assign(&mut self, other: &Self) -> Result<(), MoneyError>

Attempts to subtract another Money amount from this one in place. Returns an error if currencies mismatch or if subtraction causes an overflow/underflow.

pub fn try_mul_i64(&self, rhs: i64) -> Result<Self, MoneyError>

Attempts to multiply this Money amount by an integer scalar, returning a new Money instance. Returns an error if multiplication causes an overflow/underflow.

pub fn try_mul_f64(&self, rhs: f64) -> Result<Self, MoneyError>

Attempts to multiply this Money amount by a float scalar, returning a new Money instance. Returns an error if the result is non-finite or causes an internal conversion error. WARNING: The usage of f64 introduces floating-point precision issues. Do not use it for critical financial calculations.

pub fn try_div_i64(&self, rhs: i64) -> Result<Self, MoneyError>

Attempts to divide this Money amount by an integer scalar, returning a new Money instance. Returns an error if the divisor is zero, or if division causes an overflow/underflow.

pub fn try_div_f64(&self, rhs: f64) -> Result<Self, MoneyError>

Attempts to divide this Money amount by a float scalar, returning a new Money instance. Returns an error if the divisor is zero, non-finite, or if division causes an internal conversion error. WARNING: The usage of f64 introduces floating-point precision issues. Do not use it for critical financial calculations.

pub fn try_neg(&self) -> Result<Self, MoneyError>

Attempts to negate this Money amount, returning a new Money instance. Returns an error if negation causes an overflow/underflow.

pub fn is_currency(&self, code: &str) -> bool

Checks if the money’s currency code matches the given code. The code should be a three-letter ISO 4217 currency code (e.g., “USD”, “EUR”).

pub fn is_usd(&self) -> bool

Checks if the money’s currency is United States Dollar (USD).

pub fn is_eur(&self) -> bool

Checks if the money’s currency is Euro (EUR).

pub fn is_gbp(&self) -> bool

Checks if the money’s currency is British Pound Sterling (GBP).

pub fn is_jpy(&self) -> bool

Checks if the money’s currency is Japanese Yen (JPY).

pub fn is_cad(&self) -> bool

Checks if the money’s currency is Canadian Dollar (CAD).

pub fn is_aud(&self) -> bool

Checks if the money’s currency is Australian Dollar (AUD).

pub const fn is_positive(&self) -> bool

Checks if the money amount is strictly positive (greater than zero).

pub const fn is_negative(&self) -> bool

Checks if the money amount is strictly negative (less than zero).

pub const fn is_zero(&self) -> bool

Checks if the money amount is exactly zero.

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

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

Formats the value using the given formatter.

impl Default for Money

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Money

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Money> for Value

Available on crate feature cel only.

fn from(value: Money) -> Self

Converts to this type from the input 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 Message for Money

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Money

fn eq(&self, other: &Money) -> 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 PartialOrd for Money

fn partial_cmp(&self, other: &Self) -> 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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Money

impl StructuralPartialEq for Money