Struct LedgerCoherenceReport 

pub struct LedgerCoherenceReport {

    pub je_count: usize,
    pub line_count: usize,
    pub balanced_je_count: usize,
    pub unbalanced_je_count: usize,
    pub unbalanced_jes: Vec<UnbalancedJeRecord>,
    pub all_jes_balanced: bool,
    pub total_debits: String,
    pub total_credits: String,
    pub ledger_nets_to_zero: bool,
    pub distinct_accounts: usize,
    pub distinct_companies: usize,
    pub period_span: Option<[String; 2]>,
    pub top_account_activity: Vec<AccountActivity>,
    pub tb_period_checks: Vec<TbPeriodCheck>,
    pub all_tbs_balanced: bool,
}

Integrity self-validation report for a generated ledger.

Fields

je_count: usize

line_count: usize

balanced_je_count: usize

unbalanced_je_count: usize

unbalanced_jes: Vec<UnbalancedJeRecord>

Unbalanced entries (capped to keep the report bounded).

all_jes_balanced: bool

total_debits: String

total_credits: String

ledger_nets_to_zero: bool

True when total debits == total credits across the whole ledger.

distinct_accounts: usize

distinct_companies: usize

period_span: Option<[String; 2]>

[min_posting_date, max_posting_date] (ISO) when any entries exist.

top_account_activity: Vec<AccountActivity>

Top accounts by absolute net activity (capped).

tb_period_checks: Vec<TbPeriodCheck>

Per-period trial-balance checks (empty until the runtime populates them).

all_tbs_balanced: bool

True when every supplied period trial balance balances (vacuously true when no trial balances were supplied).

Implementations

impl LedgerCoherenceReport

pub const DEFAULT_LIST_CAP: usize = 200

Default cap on the number of unbalanced JEs / top accounts listed.

pub fn from_entries(entries: &[JournalEntry], list_cap: usize) -> Self

Compute the coherence report from journal entries alone. The trial-balance section is left empty (the runtime augments it via Self::with_tb_checks).

pub fn with_tb_checks( self, tbs: impl IntoIterator<Item = (u16, u8, Decimal, Decimal)>, ) -> Self

Attach per-period trial-balance self-balance checks. tbs is an iterator of (fiscal_year, fiscal_period, total_debit_balance, total_credit_balance).

pub fn is_coherent(&self) -> bool

True when the ledger is fully coherent: all JEs balance, the ledger nets to zero, and every supplied trial balance balances.

Trait Implementations

impl Clone for LedgerCoherenceReport

fn clone(&self) -> LedgerCoherenceReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LedgerCoherenceReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LedgerCoherenceReport

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LedgerCoherenceReport

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LedgerCoherenceReport