Struct okane_core::datamodel::Amount

pub struct Amount {
    pub value: Decimal,
    pub commodity: String,
}

Amount of posting, balance, …

Fields

value: Decimal

Numerical value.

commodity: String

Commodity aka currency.

Implementations

impl Amount

pub fn is_zero(&self) -> bool

Returns true if the amount is zero.

pub fn is_sign_positive(&self) -> bool

Returns true if the amount is positive.

pub fn is_sign_negative(&self) -> bool

Returns true if the amount is negative.

Trait Implementations

impl Clone for Amount

fn clone(&self) -> Amount

Returns a copy 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 From<Amount> for Amount

fn from(value: Amount) -> Self

Converts to this type from the input type.

impl From<Amount> for ValueExpr

fn from(value: Amount) -> Self

Converts to this type from the input type.

impl Neg for Amount

Examples

let x = okane_core::datamodel::Amount{
    value: dec!(-5),
    commodity: "JPY".to_string(),
};
let y = -x.clone();
assert_eq!(x.value, dec!(-5));
assert_eq!(x.commodity, "JPY");
assert_eq!(y.value, dec!(5));
assert_eq!(y.commodity, "JPY");

type Output = Amount

The resulting type after applying the - operator.

fn neg(self) -> Amount

Performs the unary - operation.

impl PartialEq for Amount

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Amount

impl StructuralEq for Amount

impl StructuralPartialEq for Amount