Struct Options 

pub struct Options {

    pub title: Option<String>,
    pub filename: Option<String>,
    pub operating_currency: Vec<String>,
    pub name_assets: String,
    pub name_liabilities: String,
    pub name_equity: String,
    pub name_income: String,
    pub name_expenses: String,
    pub account_rounding: Option<String>,
    pub account_previous_balances: String,
    pub account_previous_earnings: String,
    pub account_previous_conversions: String,
    pub account_current_earnings: String,
    pub account_current_conversions: Option<String>,
    pub account_unrealized_gains: Option<String>,
    pub conversion_currency: Option<String>,
    pub inferred_tolerance_default: HashMap<String, Decimal>,
    pub inferred_tolerance_multiplier: Decimal,
    pub infer_tolerance_from_cost: bool,
    pub use_legacy_fixed_tolerances: bool,
    pub experiment_explicit_tolerances: bool,
    pub booking_method: String,
    pub render_commas: bool,
    pub display_precision: HashMap<String, u32>,
    pub allow_pipe_separator: bool,
    pub long_string_maxlines: u32,
    pub documents: Vec<String>,
    pub plugin_processing_mode: String,
    pub custom: HashMap<String, String>,
    pub warnings: Vec<OptionWarning>,
    /* private fields */
}

Beancount file options.

These correspond to the option directives in beancount files.

Fields

title: Option<String>

Title for the ledger.

filename: Option<String>

Source filename (auto-set).

operating_currency: Vec<String>

Operating currencies (for reporting).

name_assets: String

Name prefix for Assets accounts.

name_liabilities: String

Name prefix for Liabilities accounts.

name_equity: String

Name prefix for Equity accounts.

name_income: String

Name prefix for Income accounts.

name_expenses: String

Name prefix for Expenses accounts.

account_rounding: Option<String>

Account for rounding errors.

account_previous_balances: String

Account for previous balances (opening balances).

account_previous_earnings: String

Account for previous earnings.

account_previous_conversions: String

Account for previous conversions.

account_current_earnings: String

Account for current earnings.

account_current_conversions: Option<String>

Account for current conversion differences.

account_unrealized_gains: Option<String>

Account for unrealized gains.

conversion_currency: Option<String>

Currency for conversion (if specified).

inferred_tolerance_default: HashMap<String, Decimal>

Default tolerances per currency (e.g., “USD:0.005” or “*:0.001”).

inferred_tolerance_multiplier: Decimal

Tolerance multiplier for balance assertions.

infer_tolerance_from_cost: bool

Whether to infer tolerance from cost.

use_legacy_fixed_tolerances: bool

Whether to use legacy fixed tolerances.

experiment_explicit_tolerances: bool

Enable experimental explicit tolerances in balance assertions.

booking_method: String

Default booking method.

render_commas: bool

Whether to render commas in numbers.

display_precision: HashMap<String, u32>

Display precision per currency (e.g., “USD:2” means format USD with 2 decimal places). Format: CURRENCY:PRECISION where PRECISION is the number of decimal places.

allow_pipe_separator: bool

Whether to allow pipe separator in numbers.

long_string_maxlines: u32

Maximum lines in multi-line strings.

documents: Vec<String>

Directories to scan for document files.

plugin_processing_mode: String

Plugin processing mode: “default” or “raw”.

custom: HashMap<String, String>

Any other custom options.

warnings: Vec<OptionWarning>

Validation warnings collected during parsing.

Implementations

impl Options

pub fn new() -> Self

Create new options with defaults.

pub fn set(&mut self, key: &str, value: &str)

Set an option by name.

Validates the option and collects any warnings in self.warnings.

pub fn get(&self, key: &str) -> Option<&str>

Get a custom option value.

pub fn account_types(&self) -> [&str; 5]

Get all account type prefixes.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl From<&Options> for CachedOptions

fn from(opts: &Options) -> Self

Converts to this type from the input type.

impl From<CachedOptions> for Options

fn from(cached: CachedOptions) -> Self

Converts to this type from the input type.