Struct BookingEngine 

pub struct BookingEngine { /* private fields */ }

Booking engine that tracks inventory across transactions.

Implementations

impl BookingEngine

pub fn new() -> Self

Create a new booking engine with default FIFO booking.

pub fn with_method(method: BookingMethod) -> Self

Create a booking engine with a specific default booking method.

pub fn set_account_method( &mut self, account: InternedStr, method: BookingMethod, )

Register the booking method for a specific account.

Call this for each open directive before booking transactions for that account, so the engine uses the per-account method (e.g. FIFO, LIFO, NONE) rather than the engine-wide default. Subsequent calls overwrite the previous method for the account.

pub fn register_account_methods<'a, I>(&mut self, directives: I)

where I: IntoIterator<Item = &'a Directive>,

Scan a sequence of directives and register any per-account booking methods found on open directives. Open directives whose booking method is absent or fails to parse are silently ignored (they fall back to the engine-wide default).

This is a convenience wrapper around Self::set_account_method for the common pipeline pattern of scanning all directives once before the booking loop. Call this before booking any transactions so the engine uses each account’s declared method rather than the engine-wide default for every account.

pub fn inventory(&self, account: &InternedStr) -> Option<&Inventory>

Get the inventory for an account.

pub fn book(&self, txn: &Transaction) -> Result<BookedTransaction, BookingError>

Book a transaction: fill in empty cost specs and calculate gains.

This does NOT modify the internal inventories - call apply for that.

When a reduction matches multiple lots (e.g., selling shares that were purchased across multiple buy transactions), the posting is expanded into multiple postings, one for each matched lot. This matches Python beancount’s behavior.

pub fn apply(&mut self, txn: &Transaction)

Apply a transaction to the inventories (update balances).

pub fn book_and_interpolate( &self, txn: &Transaction, ) -> Result<InterpolationResult, BookingError>

Book and interpolate a transaction.

This fills in empty cost specs, then interpolates any missing amounts.

Trait Implementations

impl Debug for BookingEngine

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

Formats the value using the given formatter.

impl Default for BookingEngine

fn default() -> BookingEngine

Returns the “default value” for a type.