acc 0.9.0

plaintext double-entry accounting command line tool
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

//! The `Journal` is the final product of the load pipeline. It is the
//! input every report command consumes.

use std::collections::HashMap;

use crate::indexer::Index;
use crate::parser::located::Located;
use crate::parser::transaction::Transaction;

/// A fully-processed journal: balanced, booked transactions in date
/// order, a ready-to-query price index, the FX-gain/loss account
/// declarations extracted during resolve, and a per-commodity
/// precision map derived from the postings.
#[derive(Debug)]
pub struct Journal {
    pub transactions: Vec<Located<Transaction>>,
    pub prices: Index,
    pub fx_realized_gain: Option<String>,
    pub fx_realized_loss: Option<String>,
    /// Account for positive Currency Translation Adjustments.
    /// Declared via `account NAME / cta gain`. Both `cta_gain` and
    /// `cta_loss` must be declared for the translator phase to run.
    pub cta_gain: Option<String>,
    /// Account for negative Currency Translation Adjustments.
    /// Declared via `account NAME / cta loss`.
    pub cta_loss: Option<String>,
    /// Realized-capital-gains accounts, declared via
    /// `account NAME / capital gain` / `capital loss`. Both must be
    /// declared for the lot/capital-gains phase to run.
    pub capital_gain: Option<String>,
    pub capital_loss: Option<String>,
    /// Unrealized mark-to-market accounts, declared via
    /// `account NAME / fx-unrealized gain` / `fx-unrealized loss`. Both must
    /// be declared for the `--unrealized` revaluator phase to run.
    pub fx_unrealized_gain: Option<String>,
    pub fx_unrealized_loss: Option<String>,
    /// Maximum fractional digits observed for each commodity across
    /// every posting amount / cost / balance-assertion. Reports use
    /// this to render all amounts of a commodity consistently.
    pub precisions: HashMap<String, usize>,
    /// `alias → canonical`. Lets the CLI resolve `-X EUR` to `€` when
    /// the journal declared `commodity € / alias EUR`, so the target
    /// symbol matches the form stored in postings and the price DB.
    pub aliases: HashMap<String, String>,
    /// Automated-transaction rules from `= /pattern/` blocks. Expanded
    /// into their matching transactions by the expander phase between
    /// booker and filter.
    pub auto_rules: Vec<crate::parser::entry::AutoRule>,
}