Struct CurrencyAmount 

pub struct CurrencyAmount {
    pub amount: Decimal,
    pub currency: Currency,
}

A monetary amount with a currency.

Fields

amount: Decimal

The monetary amount.

currency: Currency

The currency.

Implementations

impl CurrencyAmount

pub fn new(amount: impl Into<Decimal>, currency: Currency) -> CurrencyAmount

Creates a new CurrencyAmount from an integer value.

pub fn from_str_values( amount: &str, currency: Currency, ) -> Result<CurrencyAmount, MoneyError>

Creates a new CurrencyAmount from a string representation.

Arguments

• amount - A string like "19.99"
• currency - The currency code like "USD"

pub fn is_zero(&self) -> bool

Returns true if the amount is zero.

pub fn is_positive(&self) -> bool

Returns true if the amount is positive.

pub fn is_negative(&self) -> bool

Returns true if the amount is negative.

pub fn abs(&self) -> CurrencyAmount

Returns the absolute value of the amount.

pub fn negate(&self) -> CurrencyAmount

Negates the amount.

pub fn round(&self) -> CurrencyAmount

Rounds the amount to the currency’s decimal places.

pub fn round_to(&self, decimal_places: u32) -> CurrencyAmount

Rounds the amount to the specified number of decimal places.

pub fn to_f64(&self) -> Option<f64>

Returns the amount as a f64 (may lose precision).

pub fn parts(&self) -> (Decimal, Decimal)

Returns the major amount (whole number part) and minor amount (fractional part).

Trait Implementations

impl Add for CurrencyAmount

type Output = Result<CurrencyAmount, MoneyError>

The resulting type after applying the + operator.

fn add(self, rhs: CurrencyAmount) -> <CurrencyAmount as Add>::Output

Performs the + operation.

impl Clone for CurrencyAmount

fn clone(&self) -> CurrencyAmount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CurrencyAmount

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CurrencyAmount

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CurrencyAmount

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

Formats the value using the given formatter.

impl Eq for CurrencyAmount

impl PartialEq for CurrencyAmount

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CurrencyAmount

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 CurrencyAmount

impl Sub for CurrencyAmount

type Output = Result<CurrencyAmount, MoneyError>

The resulting type after applying the - operator.

fn sub(self, rhs: CurrencyAmount) -> <CurrencyAmount as Sub>::Output

Performs the - operation.