rustledger_core/
lib.rs

1//! Core types for rustledger
2//!
3//! This crate provides the fundamental types used throughout the rustledger project:
4//!
5//! - [`Amount`] - A decimal number with a currency
6//! - [`Cost`] - Acquisition cost of a position (lot)
7//! - [`CostSpec`] - Specification for matching or creating costs
8//! - [`Position`] - Units held at a cost
9//! - [`Inventory`] - A collection of positions with booking support
10//! - [`BookingMethod`] - How to match lots when reducing positions
11//! - [`Directive`] - All directive types (Transaction, Balance, Open, etc.)
12//!
13//! # Example
14//!
15//! ```
16//! use rustledger_core::{Amount, Cost, Position, Inventory, BookingMethod};
17//! use rust_decimal_macros::dec;
18//!
19//! // Create an inventory
20//! let mut inv = Inventory::new();
21//!
22//! // Add a stock position with cost
23//! let cost = Cost::new(dec!(150.00), "USD")
24//!     .with_date(rustledger_core::naive_date(2024, 1, 15).unwrap());
25//! inv.add(Position::with_cost(Amount::new(dec!(10), "AAPL"), cost));
26//!
27//! // Check holdings
28//! assert_eq!(inv.units("AAPL"), dec!(10));
29//!
30//! // Sell some shares using FIFO
31//! let result = inv.reduce(
32//!     &Amount::new(dec!(-5), "AAPL"),
33//!     None,
34//!     BookingMethod::Fifo,
35//! ).unwrap();
36//!
37//! assert_eq!(inv.units("AAPL"), dec!(5));
38//! assert_eq!(result.cost_basis.unwrap().number, dec!(750.00)); // 5 * 150
39//! ```
40
41#![forbid(unsafe_code)]
42#![warn(missing_docs)]
43
44pub mod amount;
45pub mod cost;
46pub mod directive;
47pub mod display_context;
48pub mod extract;
49pub mod format;
50pub mod identifiers;
51pub mod implicit_prices;
52pub mod intern;
53pub mod inventory;
54pub mod meta_json;
55pub mod position;
56pub mod shift_spans_impls;
57pub mod span;
58pub mod synthetic;
59pub mod visit;
60
61// Kani formal verification proofs (only compiled with Kani)
62#[cfg(kani)]
63mod kani_proofs;
64
65pub use amount::{Amount, AmountParseError, AmountParseErrorReason, IncompleteAmount};
66pub use cost::{BookedCost, BookedCostInvariantError, Cost, CostNumber, CostSpec};
67pub use directive::{
68    Balance, Close, Commodity, Custom, Directive, DirectivePriority, Document, Event, MetaValue,
69    Metadata, Note, Open, Pad, Posting, Price, PriceAnnotation, PriceKind, Query, Transaction,
70    booking_sort_key, parse_precision_meta, sort_directives,
71};
72pub use display_context::{DEFAULT_CURRENCY, DisplayContext, Precision};
73pub use extract::{
74    DEFAULT_CURRENCIES, extract_accounts, extract_accounts_iter, extract_currencies,
75    extract_currencies_iter, extract_links, extract_links_iter, extract_payees,
76    extract_payees_iter, extract_tags, extract_tags_iter,
77};
78pub use format::{
79    Alignment, FormatConfig, FormatLine, format_directive_lines, format_directives,
80    format_posting_line, posting_format_line, render_lines, resolve_alignment,
81};
82pub use identifiers::{
83    ACCOUNT_TYPES, Account, Currency, Link, Tag, account_type, is_subaccount_or_equal,
84};
85pub use implicit_prices::extract_per_unit_price;
86pub use intern::{InternedStr, StringInterner};
87pub use inventory::{
88    AccountedBookingError, BookingError, BookingMethod, BookingResult, Inventory, ReductionScope,
89    sum_account_and_subaccounts,
90};
91pub use meta_json::{json_to_meta_value, meta_value_to_json, meta_value_type_tag};
92pub use position::Position;
93pub use span::{SYNTHESIZED_FILE_ID, ShiftSpans, Span, Spanned};
94pub use visit::{visit_accounts, visit_currencies};
95
96// Re-export commonly used external types
97/// Calendar date without timezone. Alias for `jiff::civil::Date`.
98pub type NaiveDate = jiff::civil::Date;
99pub use rust_decimal::Decimal;
100
101/// Construct a [`NaiveDate`] from `(year, month, day)` with i32/u32 arguments.
102///
103/// Wraps [`jiff::civil::date`] which takes `(i16, i8, i8)`.
104/// Returns `None` if the date is invalid.
105#[must_use]
106pub fn naive_date(year: i32, month: u32, day: u32) -> Option<NaiveDate> {
107    let y = i16::try_from(year).ok()?;
108    let m = i8::try_from(month).ok()?;
109    let d = i8::try_from(day).ok()?;
110    NaiveDate::new(y, m, d).ok()
111}
112
113// Re-export rkyv wrappers when feature is enabled
114#[cfg(feature = "rkyv")]
115pub use intern::{AsDecimal, AsInternedStr, AsNaiveDate};
rustledger_core/lib.rs

rustledger_core/
lib.rs
