Skip to main content

JournalEntry

Struct JournalEntry 

Source
pub struct JournalEntry { /* private fields */ }
Expand description

A balanced journal entry.

Implementations§

Source§

impl JournalEntry

Source

pub fn new( entry_id: impl AsRef<str>, postings: Vec<Posting>, ) -> Result<JournalEntry, 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.

Source

pub fn entry_id(&self) -> &str

Returns the journal entry identifier.

Source

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

Returns the postings.

Source

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

Iterates over postings.

Source

pub fn is_balanced(&self) -> bool

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

Trait Implementations§

Source§

impl Clone for JournalEntry

Source§

fn clone(&self) -> JournalEntry

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for JournalEntry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> IntoIterator for &'a JournalEntry

Source§

type Item = &'a Posting

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, Posting>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> <&'a JournalEntry as IntoIterator>::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for JournalEntry

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for JournalEntry

Source§

impl StructuralPartialEq for JournalEntry

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.