pactole-core 0.2.0

Core domain models, validation and reports for Pactole, a plain-text double-entry accounting ledger.
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

use crate::models::names::{AccountName, CommodityName, Metadata};
use chrono::NaiveDate;
use rust_decimal::Decimal;

// -------------------------------------------------
// Assertions
// -------------------------------------------------

/// Expected balance of an account on a date.
#[derive(Debug, Clone, PartialEq)]
pub struct Balance {
    /// Date of the assertion.
    pub date: NaiveDate,
    /// Account whose balance is asserted.
    pub account: AccountName,
    /// Expected amount.
    pub amount: Amount,
    /// Optional allowed difference. Without it, the assertion must match
    /// exactly.
    pub tolerance: Option<Decimal>,
    /// Metadata attached to the directive.
    pub meta: Metadata,
}

// -------------------------------------------------
// Misc
// -------------------------------------------------

/// A decimal quantity paired with its commodity.
#[derive(Debug, Clone, PartialEq)]
pub struct Amount {
    /// Numeric quantity, represented exactly as a decimal.
    pub number: Decimal,
    /// Commodity in which the quantity is expressed.
    pub commodity: CommodityName,
}