Struct AggregateOptions 

pub struct AggregateOptions {
    pub prior_period_aggregate: Option<PathBuf>,
    pub tolerate_missing_shards: bool,
    pub cgu_test_inputs: Vec<CguTestInputs>,
    pub cpi_series_by_currency: BTreeMap<String, GeneralPriceIndex>,
}

Knobs the caller can supply to tune run_aggregate behaviour.

All fields are optional; the Default impl gives the production fail-fast contract (no prior period, missing shards are errors).

Fields

prior_period_aggregate: Option<PathBuf>

Optional path to a prior period’s consolidated/ directory’s parent — i.e. the prior period’s out_dir. When supplied, opening NCI, equity-method carrying values, and CTA balances are loaded from prior_period_aggregate/consolidated/{nci_rollforward,equity_method_investments,cta_rollforward}.json. When None, every opening defaults to zero per entity.

tolerate_missing_shards: bool

When true, missing per-entity shard archives produce a warning rather than an error — useful for partial-archive recovery scenarios. Defaults to false: missing shards fail fast.

cgu_test_inputs: Vec<CguTestInputs>

v5.2 IAS 36 § 10 — per-period CGU goodwill impairment test inputs. Each entry references a CGU defined in crate::manifest::GroupManifest::cgu_plan and supplies the CGU’s other-asset carrying amount, fair-value-less-costs, and value-in-use estimates for this period. When non-empty, run_aggregate joins these against the manifest plan, runs datasynth_core::models::CguImpairmentTest::run per CGU, and emits consolidated/cgu_impairment_tests.json. When empty (default), no impairment tests run and no artefact is emitted — preserves backwards compatibility byte-for-byte for engagements without CGU configuration.

cpi_series_by_currency: BTreeMap<String, GeneralPriceIndex>

v5.5.2 IAS 29 § 12 — per-currency general price index (CPI) series, keyed by ISO 4217 currency code. When supplied, the aggregate driver matches each entity in datasynth_core::models::HyperinflationStatus::Hyperinflationary against this map by its functional currency. Matched entities are translated via translate_entity_tb_with_indexed_restatement (composing IAS 29 § 12 indexed restatement with IAS 21 § 42(b) closing-rate translation). Hyperinflationary entities without a matching currency entry log a warning and fall back to the closing-rate-only path (the v5.5.0 behaviour). Non-hyperinflationary entities ignore this map. Empty (default) preserves backwards-compatible behaviour byte-for-byte.

Trait Implementations

impl Clone for AggregateOptions

fn clone(&self) -> AggregateOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AggregateOptions

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

Formats the value using the given formatter.

impl Default for AggregateOptions

fn default() -> AggregateOptions

Returns the “default value” for a type.