Struct Money 

pub struct Money { /* private fields */ }

A monetary amount paired with its currency.

This type ensures that amounts always carry their currency context, preventing accidental mixing of currencies in arithmetic operations.

Example

use stateset_primitives::{Money, CurrencyCode};
use rust_decimal_macros::dec;

let price = Money::new(dec!(29.99), CurrencyCode::USD);
assert_eq!(price.amount(), dec!(29.99));
assert_eq!(price.currency(), CurrencyCode::USD);
assert_eq!(format!("{}", price), "29.99 USD");

Implementations

impl Money

pub const fn new(amount: Decimal, currency: CurrencyCode) -> Money

Create a new monetary value.

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

Create a zero amount in the given currency.

pub const fn amount(&self) -> Decimal

Get the amount.

pub const fn currency(&self) -> CurrencyCode

Get the currency code.

pub const fn is_zero(&self) -> bool

Returns true if the amount is zero.

pub const fn is_positive(&self) -> bool

Returns true if the amount is positive.

pub const fn is_negative(&self) -> bool

Returns true if the amount is negative.

pub fn checked_add(self, other: Money) -> Option<Money>

Add two monetary values.

Returns None if the currencies don’t match or if the underlying Decimal addition overflows. This method never panics.

pub fn checked_sub(self, other: Money) -> Option<Money>

Subtract two monetary values.

Returns None if the currencies don’t match or if the underlying Decimal subtraction overflows. This method never panics.

pub fn round_dp(self, dp: u32) -> Money

Round to a given number of decimal places.

pub fn checked_mul_scalar(self, factor: Decimal) -> Option<Money>

Multiply by a scalar factor (e.g., quantity or tax rate). Currency is preserved.

Returns None if the underlying Decimal multiplication overflows. This method never panics.

pub fn checked_div_scalar(self, divisor: Decimal) -> Option<Money>

Divide by a scalar.

Returns None if the divisor is zero or if the underlying Decimal division overflows. This method never panics.

pub fn abs(self) -> Money

Return the absolute value of this monetary amount.

pub fn negate(self) -> Money

Negate this monetary amount.

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<'de> Deserialize<'de> for Money

fn deserialize<__D>( __deserializer: __D, ) -> Result<Money, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Money

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

Formats the value using the given formatter.

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

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

Equality operator ==.

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

Inequality 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