Struct ParsedLedger 

pub struct ParsedLedger { /* private fields */ }

A parsed and validated ledger that caches the parse result.

Use this class when you need to perform multiple operations on the same source without re-parsing each time.

Example (JavaScript)

const ledger = new ParsedLedger(source);
if (ledger.isValid()) {
    const balances = ledger.query("BALANCES");
    const formatted = ledger.format();
}

Implementations

impl ParsedLedger

pub fn new(source: &str) -> Self

Create a new ParsedLedger from source text.

Parses, interpolates, and validates the source. Call isValid() to check for errors.

pub fn is_valid(&self) -> bool

Check if the ledger is valid (no parse or validation errors).

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

Get all errors (parse + validation).

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

Get parse errors only.

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

Get validation errors only.

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 format(&self) -> Result<JsValue, JsError>

Format the ledger source.

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, line: u32, character: u32, ) -> Result<JsValue, JsError>

Get completions at the given position.

Returns context-aware completions for accounts, currencies, directives, etc. Uses cached account/currency/payee data for efficiency.

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

Get hover information at the given position.

Returns documentation for accounts, currencies, and directive keywords.

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

Get the definition location for the symbol at the given position.

Returns the location of the open or commodity directive for accounts/currencies. Uses cached LineIndex for O(log n) position lookups.

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

Get all document symbols for the outline view.

Returns a hierarchical list of all directives with their positions. Uses cached LineIndex for O(log n) position lookups.

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

Find all references to the symbol at the given position.

Returns all occurrences of accounts, currencies, or payees in the document. Uses cached data for efficient lookup.

Trait Implementations

impl From<ParsedLedger> for JsValue

fn from(value: ParsedLedger) -> Self

Converts to this type from the input type.

impl FromWasmAbi for ParsedLedger

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 ParsedLedger

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 ParsedLedger

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<ParsedLedger>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for ParsedLedger

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 ParsedLedger

fn none() -> Self::Abi

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

impl RefFromWasmAbi for ParsedLedger

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<ParsedLedger>

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 ParsedLedger

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<ParsedLedger>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for ParsedLedger

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 ParsedLedger

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

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

impl VectorIntoWasmAbi for ParsedLedger

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

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

impl WasmDescribe for ParsedLedger

fn describe()

impl WasmDescribeVector for ParsedLedger

fn describe_vector()

impl SupportsConstructor for ParsedLedger

impl SupportsInstanceProperty for ParsedLedger

impl SupportsStaticProperty for ParsedLedger