Struct NotesGeneratorContext 

pub struct NotesGeneratorContext {

    pub entity_code: String,
    pub framework: String,
    pub period: String,
    pub period_end: NaiveDate,
    pub currency: String,
    pub revenue_contract_count: usize,
    pub revenue_amount: Option<Decimal>,
    pub avg_obligations_per_contract: Option<Decimal>,
    pub total_ppe_gross: Option<Decimal>,
    pub accumulated_depreciation: Option<Decimal>,
    pub statutory_tax_rate: Option<Decimal>,
    pub effective_tax_rate: Option<Decimal>,
    pub deferred_tax_asset: Option<Decimal>,
    pub deferred_tax_liability: Option<Decimal>,
    pub provision_count: usize,
    pub total_provisions: Option<Decimal>,
    pub related_party_transaction_count: usize,
    pub related_party_total_value: Option<Decimal>,
    pub subsequent_event_count: usize,
    pub adjusting_event_count: usize,
    pub pension_plan_count: usize,
    pub total_dbo: Option<Decimal>,
    pub total_plan_assets: Option<Decimal>,
}

Summary data drawn from the overall generation result, passed into the notes generator so it can decide which notes to include and what numbers to populate them with.

Fields

entity_code: String

Entity / company code for which notes are prepared.

framework: String

Reporting framework name (e.g. “IFRS”, “US GAAP”).

period: String

Fiscal period descriptor (e.g. “FY2024”).

period_end: NaiveDate

Period end date.

currency: String

Reporting currency code (e.g. “USD”).

revenue_contract_count: usize

Number of customer contracts recognised during the period.

revenue_amount: Option<Decimal>

Total revenue amount.

avg_obligations_per_contract: Option<Decimal>

Average number of performance obligations per contract.

total_ppe_gross: Option<Decimal>

Total gross fixed asset carrying amount.

accumulated_depreciation: Option<Decimal>

Accumulated depreciation on fixed assets.

statutory_tax_rate: Option<Decimal>

Statutory tax rate (e.g. 0.21 for 21 %).

effective_tax_rate: Option<Decimal>

Effective tax rate actually incurred.

deferred_tax_asset: Option<Decimal>

Deferred tax asset balance.

deferred_tax_liability: Option<Decimal>

Deferred tax liability balance.

provision_count: usize

Number of provisions recognised.

total_provisions: Option<Decimal>

Total carrying value of all provisions.

related_party_transaction_count: usize

Number of related party transactions identified.

related_party_total_value: Option<Decimal>

Total value of related party transactions.

subsequent_event_count: usize

Number of subsequent events identified.

adjusting_event_count: usize

Number of adjusting subsequent events.

pension_plan_count: usize

Number of defined benefit plans.

total_dbo: Option<Decimal>

Total DBO at period end.

total_plan_assets: Option<Decimal>

Total plan assets at fair value.

Trait Implementations

impl Clone for NotesGeneratorContext

fn clone(&self) -> NotesGeneratorContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotesGeneratorContext

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

Formats the value using the given formatter.

impl Default for NotesGeneratorContext

fn default() -> NotesGeneratorContext

Returns the “default value” for a type.