Struct Loader 

pub struct Loader { /* private fields */ }

Beancount file loader.

Implementations

impl Loader

pub fn new() -> Self

Create a new loader.

pub const fn with_path_security(self, enabled: bool) -> Self

Enable path traversal protection.

When enabled, include directives cannot escape the root directory of the main beancount file. This prevents malicious ledger files from accessing sensitive files outside the ledger directory.

Example

let result = Loader::new()
    .with_path_security(true)
    .load(Path::new("ledger.beancount"))?;

pub fn with_root_dir(self, root: PathBuf) -> Self

Set a custom root directory for path security.

By default, the root directory is the parent directory of the main file. This method allows overriding that to a custom directory.

pub fn load(&mut self, path: &Path) -> Result<LoadResult, LoadError>

Load a beancount file and all its includes.

Parses the file, processes options and plugin directives, and recursively loads any included files.

Errors

Returns LoadError in the following cases:

• LoadError::Io - Failed to read the file or an included file
• LoadError::IncludeCycle - Circular include detected

Note: Parse errors and path traversal errors are collected in LoadResult::errors rather than returned directly, allowing partial results to be returned.

Trait Implementations

impl Debug for Loader

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

Formats the value using the given formatter.

impl Default for Loader

fn default() -> Loader

Returns the “default value” for a type.