Struct JournalEntry 

pub struct JournalEntry { /* private fields */ }

A balanced journal entry.

Implementations

impl JournalEntry

pub fn new( entry_id: impl AsRef<str>, postings: Vec<Posting>, ) -> Result<Self, LedgerError>

Creates a journal entry and validates that debits and credits balance.

Errors

Returns LedgerError::EmptyEntryId for an empty entry identifier, LedgerError::NoPostings when no postings are supplied, and LedgerError::NotBalanced when debits and credits do not balance by currency and scale.

pub fn entry_id(&self) -> &str

Returns the journal entry identifier.

pub fn postings(&self) -> &[Posting]

Returns the postings.

pub fn iter(&self) -> Iter<'_, Posting>

Iterates over postings.

pub fn is_balanced(&self) -> bool

Returns whether debits and credits balance by currency and amount scale.

Trait Implementations

impl Clone for JournalEntry

fn clone(&self) -> JournalEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JournalEntry

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

Formats the value using the given formatter.

impl Eq for JournalEntry

impl<'a> IntoIterator for &'a JournalEntry

type Item = &'a Posting

The type of the elements being iterated over.

type IntoIter = Iter<'a, Posting>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for JournalEntry

fn eq(&self, other: &JournalEntry) -> 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 StructuralPartialEq for JournalEntry