Struct Ledger 

pub struct Ledger { /* private fields */ }

A fully processed multi-file ledger for queries and validation.

Use this class for ledgers that span multiple files with include directives. Caches the processed result for efficient repeated queries.

For single-file ledgers with editor features, use ParsedLedger instead.

Example (JavaScript)

const ledger = Ledger.fromFiles({
    "main.beancount": 'include "accounts.beancount"\n...',
    "accounts.beancount": "2024-01-01 open Assets:Bank USD\n..."
}, "main.beancount");

if (ledger.isValid()) {
    const balances = ledger.query("BALANCES");
    const completions = ledger.getCompletions(currentSource, line, char);
}

Implementations

impl Ledger

pub fn from_files(files: JsValue, entry_point: &str) -> Result<Self, JsError>

Create a Ledger from multiple files with include resolution.

Loads, sorts, books, runs plugins, and validates the ledger using the same processing pipeline as the CLI.

Arguments

• files - A JavaScript object mapping file paths to their contents.
• entry_point - The main file to start loading from (must exist in files).

pub fn is_valid(&self) -> bool

Check if the ledger is valid (no errors).

pub fn get_errors(&self) -> Result<JsValue, JsError>

Get all errors.

pub fn get_directives(&self) -> Result<JsValue, JsError>

Get the parsed directives.

pub fn get_options(&self) -> Result<JsValue, JsError>

Get the ledger options.

pub fn directive_count(&self) -> usize

Get the number of directives.

pub fn query(&self, query_str: &str) -> Result<JsValue, JsError>

Run a BQL query on this ledger.

pub fn balances(&self) -> Result<JsValue, JsError>

Get account balances (shorthand for query(“BALANCES”)).

pub fn expand_pads(&self) -> Result<JsValue, JsError>

Expand pad directives.

pub fn run_plugin(&self, plugin_name: &str) -> Result<JsValue, JsError>

Run a native plugin on this ledger.

pub fn get_completions( &self, source: &str, line: u32, character: u32, ) -> Result<JsValue, JsError>

Get completions for a source string using cross-file data.

Pass the source text of the file currently being edited. Completions use accounts, currencies, and payees from all loaded files.

pub fn serialize(&self) -> Result<Vec<u8>, JsError>

Serialize this ledger to a compact binary blob (rkyv).

Store the bytes in OPFS or IndexedDB alongside a source fingerprint (see crate::hash_sources) and restore later with Ledger::from_cache.

pub fn from_cache(bytes: &[u8]) -> Result<Self, JsError>

Restore a Ledger from bytes produced by Ledger::serialize.

Errors

Returns an error if the bytes are invalid or were produced by a different library version.

Trait Implementations

impl From<Ledger> for JsValue

fn from(value: Ledger) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Ledger

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for Ledger

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for Ledger

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<Ledger>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Ledger

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Ledger

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Ledger

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<Ledger>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Ledger

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<Ledger>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for Ledger

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.

impl VectorFromWasmAbi for Ledger

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Ledger]>

impl VectorIntoWasmAbi for Ledger

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Ledger]>) -> Self::Abi

impl WasmDescribe for Ledger

fn describe()

impl WasmDescribeVector for Ledger

fn describe_vector()

impl SupportsConstructor for Ledger

impl SupportsInstanceProperty for Ledger

impl SupportsStaticProperty for Ledger