Struct Amount 

pub struct Amount { /* private fields */ }

A decimal-safe amount represented as integer minor units and a decimal scale.

Implementations

impl Amount

pub const fn from_minor_units( minor_units: i128, scale: u8, ) -> Result<Self, AmountError>

Creates an amount from integer minor units and a decimal scale.

Errors

Returns AmountError::ScaleTooLarge when scale is greater than 18.

pub const fn zero(scale: u8) -> Result<Self, AmountError>

Creates a zero amount at the requested scale.

Errors

Returns AmountError::ScaleTooLarge when scale is greater than 18.

pub const fn minor_units(self) -> i128

Returns the integer minor-unit value.

pub const fn scale(self) -> u8

Returns the decimal scale.

pub const fn is_zero(self) -> bool

Returns whether this amount is zero.

pub const fn is_positive(self) -> bool

Returns whether this amount is greater than zero.

pub const fn is_negative(self) -> bool

Returns whether this amount is less than zero.

pub const fn checked_abs(self) -> Result<Self, AmountError>

Returns the absolute value of this amount.

Errors

Returns AmountError::Overflow when the absolute value cannot be represented.

pub fn checked_add(self, other: Self) -> Result<Self, AmountError>

Adds two same-scale amounts.

Errors

Returns AmountError::ScaleMismatch when scales differ and AmountError::Overflow when the integer addition overflows.

pub fn checked_sub(self, other: Self) -> Result<Self, AmountError>

Subtracts two same-scale amounts.

Errors

Returns AmountError::ScaleMismatch when scales differ and AmountError::Overflow when the integer subtraction overflows.

pub fn checked_rescale(self, new_scale: u8) -> Result<Self, AmountError>

Rescales an amount without losing precision.

Errors

Returns AmountError::ScaleTooLarge for unsupported scales, AmountError::Overflow when scaling up overflows, and AmountError::PrecisionLoss when scaling down would discard non-zero digits.

pub const fn normalize(self) -> Self

Removes trailing decimal zeroes from the minor-unit representation.

Trait Implementations

impl Clone for Amount

fn clone(&self) -> Amount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Amount

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

Formats the value using the given formatter.

impl Display for Amount

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

Formats the value using the given formatter.

impl Hash for Amount

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

fn cmp(&self, other: &Amount) -> 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.

impl PartialEq for Amount

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

fn partial_cmp(&self, other: &Amount) -> 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 Copy for Amount

impl Eq for Amount

impl StructuralPartialEq for Amount