Struct Balance

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

Accumulated balance of accounts.

Implementations

impl<'ctx> Balance<'ctx>

pub fn add_amount( &mut self, account: Account<'ctx>, amount: Amount<'ctx>, ) -> &Amount<'ctx>

Adds a particular account value, and returns the updated balance.

pub fn add_posting_amount( &mut self, account: Account<'ctx>, amount: PostingAmount<'ctx>, ) -> &Amount<'ctx>

Adds a particular account value with the specified commodity, and returns the updated balance.

pub fn set_partial( &mut self, account: Account<'ctx>, amount: PostingAmount<'ctx>, ) -> Result<PostingAmount<'ctx>, BalanceError>

Tries to set the particular account’s balance with the specified commodity, and returns the delta which should have caused the difference.

pub fn get(&self, account: &Account<'ctx>) -> Option<&Amount<'ctx>>

Gets the balance of the given account.

pub fn into_vec(self) -> Vec<(Account<'ctx>, Amount<'ctx>)>

Constructs sorted vec of account and commodity tuple.

Trait Implementations

impl<'ctx> Clone for Balance<'ctx>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'ctx> Debug for Balance<'ctx>

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

Formats the value using the given formatter.

impl<'ctx> Default for Balance<'ctx>

fn default() -> Balance<'ctx>

Returns the “default value” for a type.

impl<'ctx> FromIterator<(Account<'ctx>, Amount<'ctx>)> for Balance<'ctx>

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = (Account<'ctx>, Amount<'ctx>)>,

Constructs Balance instance out of Iterator.

impl<'ctx> PartialEq for Balance<'ctx>

fn eq(&self, other: &Balance<'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<'ctx> Eq for Balance<'ctx>

impl<'ctx> StructuralPartialEq for Balance<'ctx>