Struct ledger_rs_lib::amount::Amount

pub struct Amount {
    pub quantity: Decimal,
    pub commodity_index: Option<NodeIndex>,
}

Fields

quantity: Decimal

commodity_index: Option<NodeIndex>

Implementations

impl Amount

pub fn new(quantity: Decimal, commodity_index: Option<NodeIndex>) -> Self

pub fn abs(&self) -> Amount

Returns an absolute (positive) Amount.

pub fn parse(amount: &str, commodity_index: Option<NodeIndex>) -> Option<Self>

Creates a new Amount instance. Parses the quantity only and uses the given commodity index.

pub fn copy_from(other: &Amount) -> Self

pub fn null() -> Self

pub fn add(&mut self, other: &Amount)

pub fn inverse(&self) -> Amount

Creates an amount with the opposite sign on the quantity.

pub fn invert(&mut self)

Inverts the sign on the amount.

pub fn is_null(&self) -> bool

Indicates whether the amount is initialized. This is a 0 quantity and no Commodity.

pub fn is_zero(&self) -> bool

Trait Implementations

impl Add<Amount> for Amount

type Output = Amount

The resulting type after applying the + operator.

fn add(self, rhs: Amount) -> Self::Output

Performs the + operation.

impl AddAssign<Amount> for Amount

fn add_assign(&mut self, other: Amount)

Performs the += operation.

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

type Output = Amount

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl From<i32> for Amount

fn from(value: i32) -> Self

Converts to this type from the input type.

impl Mul<Amount> for Amount

type Output = Amount

The resulting type after applying the * operator.

fn mul(self, other: Amount) -> Amount

Performs the * operation.

impl PartialEq<Amount> 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 SubAssign<Amount> for Amount

fn sub_assign(&mut self, other: Amount)

Performs the -= operation.

impl Copy for Amount

impl StructuralPartialEq for Amount