Struct ValidationOptions 

#[non_exhaustive]
pub struct ValidationOptions {
    pub require_commodities: bool,
    pub check_documents: bool,
    pub warn_future_dates: bool,
    pub document_base: Option<PathBuf>,
    pub document_dirs: Vec<PathBuf>,
    pub document_source_dirs: Vec<PathBuf>,
    pub account_types: Vec<String>,
    pub infer_tolerance_from_cost: bool,
    pub tolerance_multiplier: Decimal,
    pub inferred_tolerance_default: FxHashMap<String, Decimal>,
    pub default_booking_method: BookingMethod,
}

Validation options.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

require_commodities: bool

Whether to require commodity declarations.

check_documents: bool

Whether to check if document files exist.

warn_future_dates: bool

Whether to warn about future-dated entries.

document_base: Option<PathBuf>

Base directory for resolving relative document paths.

document_dirs: Vec<PathBuf>

Document directories from option "documents". Relative document paths are resolved against these directories. Paths are resolved against the ledger file’s directory at load time.

document_source_dirs: Vec<PathBuf>

Directory of each source file, indexed by file_id (the u16 carried by Spanned<Directive>). A relative document path with no document_base/documents option is resolved against its own directive’s source-file directory — matching Beancount, which normalizes the path at parse time, and include, which resolves relative to the including file. Empty for callers that don’t supply source locations (the resolution then falls back to the process CWD, the pre-fix behavior).

account_types: Vec<String>

Valid account type prefixes (from options like name_assets, name_liabilities, etc.). Defaults to ["Assets", "Liabilities", "Equity", "Income", "Expenses"].

infer_tolerance_from_cost: bool

Whether to infer tolerance from cost (matches Python beancount’s infer_tolerance_from_cost). When true, tolerance for cost-based postings is calculated as: units_quantum * cost_per_unit.

tolerance_multiplier: Decimal

Tolerance multiplier (matches Python beancount’s inferred_tolerance_multiplier). Default is 0.5.

inferred_tolerance_default: FxHashMap<String, Decimal>

Per-currency default tolerances (matches Python beancount’s inferred_tolerance_default). e.g., {"GBP": 0.004} means GBP transactions tolerate up to 0.004 residual.

default_booking_method: BookingMethod

Default booking method for accounts without an explicit method on their open directive. Sourced from the file-level option "booking_method" (or the API-level LoadOptions default). Mirrors the resolved effective_method the booking engine sees — without this, the validator’s per-account lot-matching pass falls back to BookingMethod::default() (i.e., STRICT) regardless of the file’s stated method, re-raising the very NoMatchingLot/AmbiguousMatch errors the booker just decided to skip under NONE (issue #1182).

Implementations

impl ValidationOptions

pub fn with_account_types(self, types: Vec<String>) -> Self

Set account types.

pub const fn with_require_commodities(self, require: bool) -> Self

Set whether to require commodity declarations.

pub const fn with_check_documents(self, check: bool) -> Self

Set whether to check if document files exist.

pub const fn with_warn_future_dates(self, warn: bool) -> Self

Set whether to warn about future-dated entries.

pub fn with_document_dirs(self, dirs: Vec<PathBuf>) -> Self

Set document directories (resolved paths).

pub fn with_document_source_dirs(self, dirs: Vec<PathBuf>) -> Self

Set per-file_id source-file directories, used to resolve relative document paths against their own directive’s file (see the field doc on ValidationOptions::document_source_dirs).

pub const fn with_infer_tolerance_from_cost(self, infer: bool) -> Self

Set whether to infer tolerance from cost.

pub const fn with_tolerance_multiplier(self, multiplier: Decimal) -> Self

Set tolerance multiplier.

pub fn with_inferred_tolerance_default( self, defaults: FxHashMap<String, Decimal>, ) -> Self

Set per-currency default tolerances.

pub const fn with_default_booking_method(self, method: BookingMethod) -> Self

Set the default booking method (file-level option "booking_method"). Accounts without an explicit method on their open directive inherit this rather than falling through to BookingMethod::default().

Trait Implementations

impl Clone for ValidationOptions

fn clone(&self) -> ValidationOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationOptions

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

Formats the value using the given formatter.

impl Default for ValidationOptions

fn default() -> Self

Returns the “default value” for a type.