Struct Amount 

pub struct Amount { /* private fields */ }

Represents a dollar amount.

This type wraps Decimal and provides custom serialization/deserialization to handle amounts that may be formatted with or without dollar signs or commas.

Formatting is considered significant for the purposes of equality, so for numeric comparisons, you should access the Decimal value and use that.

Examples

Parsing with dollar sign:

let amount = Amount::from_str("-$50.00").unwrap();
assert_eq!(amount.to_string(), "-$50.00");

Parsing without dollar sign:

let amount = Amount::from_str("-50.00").unwrap();
assert_ne!(amount.to_string(), "-$50.00");
assert_eq!(amount.to_string(), "-50.00");

Value equivalency, but not absolute equivalency

let a = Amount::from_str("-5000.00").unwrap();
let b = Amount::from_str("-$5,000.00").unwrap();
assert_ne!(a, b);
assert_ne!(a.to_string(), b.to_string());
assert_eq!(a.value(), b.value());

Implementations

impl Amount

pub const fn new(value: Decimal) -> Self

Creates a new Amount from a Decimal value with default String formatting.

pub const fn new_with_format(value: Decimal, format: AmountFormat) -> Self

Creates a new Amount from a Decimal value with default specified formatting.

pub fn value(&self) -> Decimal

Returns the underlying Decimal value.

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.

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

fn default() -> Amount

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Amount

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Amount

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

Formats the value using the given formatter.

impl From<Amount> for Decimal

fn from(amount: Amount) -> Self

Converts to this type from the input type.

impl From<Decimal> for Amount

fn from(value: Decimal) -> Self

Converts to this type from the input type.

impl FromStr for Amount

type Err = AmountError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(_: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Amount

impl Eq for Amount

impl StructuralPartialEq for Amount