Struct Amount 

pub struct Amount<'ctx> { /* private fields */ }

Amount with multiple commodities, or simple zero.

Implementations

impl<'ctx> Amount<'ctx>

pub fn zero() -> Self

Creates an Amount with zero value.

pub fn from_value(amount: Decimal, commodity: Commodity<'ctx>) -> Self

Creates an Amount with single value and commodity.

pub fn from_values<T>(values: T) -> Self

where T: IntoIterator<Item = (Decimal, Commodity<'ctx>)>,

Creates an Amount from a set of values.

pub fn into_values(self) -> HashMap<Commodity<'ctx>, Decimal>

Takes out the instance and returns map from commodity to its value.

pub fn iter(&self) -> impl Iterator<Item = SingleAmount<'ctx>> + '_

Returns iterator over its amount.

pub fn as_inline_display(&self) -> impl Display + '_

Returns an objectt to print the amount as inline.

pub fn is_absolute_zero(&self) -> bool

Returns true if this is ‘non-commoditized zero’, which is used to assert the account balance is completely zero.

pub fn is_zero(&self) -> bool

Returns true if this is zero, including zero commodities.

pub fn remove_zero_entries(&mut self)

Removes zero values, useful when callers doesn’t care zero value. However, if caller must distinguish 0 and 0 commodity, caller must not use this method.

pub fn maybe_pair(&self) -> Option<(SingleAmount<'ctx>, SingleAmount<'ctx>)>

Returns pair of commodity amount, if the amount contains exactly 2 commodities. Otherwise returns None.

pub fn round(self, ctx: &ReportContext<'_>) -> Self

Rounds the given Amount and returns the new instance.

pub fn round_mut(&mut self, ctx: &ReportContext<'_>)

Rounds the Amount in-place with the given context provided precision.

pub fn negate(self) -> Self

Creates negated instance.

pub fn check_div(self, rhs: Decimal) -> Result<Self, EvalError>

Run division with error checking.

Trait Implementations

impl<'ctx> Add<SingleAmount<'ctx>> for Amount<'ctx>

type Output = Amount<'ctx>

The resulting type after applying the + operator.

fn add(self, rhs: SingleAmount<'ctx>) -> Self::Output

Performs the + operation.

impl Add for Amount<'_>

type Output = Amount<'_>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'ctx> AddAssign<SingleAmount<'ctx>> for Amount<'ctx>

fn add_assign(&mut self, rhs: SingleAmount<'ctx>)

Performs the += operation.

impl AddAssign for Amount<'_>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<'ctx> Clone for Amount<'ctx>

fn clone(&self) -> Amount<'ctx>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'ctx> Debug for Amount<'ctx>

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

Formats the value using the given formatter.

impl<'ctx> Default for Amount<'ctx>

fn default() -> Amount<'ctx>

Returns the “default value” for a type.

impl<'ctx> From<SingleAmount<'ctx>> for Amount<'ctx>

fn from(value: SingleAmount<'ctx>) -> Self

Converts to this type from the input type.

impl Mul<Decimal> for Amount<'_>

type Output = Amount<'_>

The resulting type after applying the * operator.

fn mul(self, rhs: Decimal) -> Self::Output

Performs the * operation.

impl MulAssign<Decimal> for Amount<'_>

fn mul_assign(&mut self, rhs: Decimal)

Performs the *= operation.

impl Neg for Amount<'_>

type Output = Amount<'_>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<'ctx> PartialEq for Amount<'ctx>

fn eq(&self, other: &Amount<'ctx>) -> 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 Sub for Amount<'_>

type Output = Amount<'_>

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Amount<'_>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<'ctx> TryFrom<&Amount<'ctx>> for SingleAmount<'ctx>

type Error = EvalError

The type returned in the event of a conversion error.

fn try_from(value: &Amount<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> TryFrom<Amount<'ctx>> for SingleAmount<'ctx>

type Error = EvalError

The type returned in the event of a conversion error.

fn try_from(value: Amount<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> Eq for Amount<'ctx>

impl<'ctx> StructuralPartialEq for Amount<'ctx>