Struct ScheduledCashFlow 

pub struct ScheduledCashFlow {
    pub amount: f64,
    pub frequency: ScheduleFrequency,
    pub start_date: Option<String>,
    pub end_date: Option<String>,
    pub allocation: CashFlowAllocation,
}

A recurring cash flow schedule for the portfolio.

Generates automatic additions or withdrawals at regular intervals during the performance simulation. Multiple schedules can be combined (e.g. monthly contributions + quarterly withdrawals).

Fields

• amount — Dollar amount per occurrence. Positive for additions, negative for withdrawals.
• frequency — How often the cash flow occurs.
• start_date — Optional start date ("YYYY-MM-DD"). If None, starts from the first portfolio date.
• end_date — Optional end date ("YYYY-MM-DD"). If None, continues until the last portfolio date.
• allocation — How the cash flow is distributed across assets.

Example

use finalytics::prelude::*;

// $2,000/month DCA distributed by target weights
let dca = ScheduledCashFlow {
    amount: 2_000.0,
    frequency: ScheduleFrequency::Monthly,
    start_date: None,
    end_date: None,
    allocation: CashFlowAllocation::ProRata,
};

// $5,000/quarter withdrawal from overweight assets
let withdrawal = ScheduledCashFlow {
    amount: -5_000.0,
    frequency: ScheduleFrequency::Quarterly,
    start_date: Some("2024-06-01".to_string()),
    end_date: None,
    allocation: CashFlowAllocation::Rebalance,
};

Fields

amount: f64

Dollar amount per occurrence: positive = addition, negative = withdrawal.

frequency: ScheduleFrequency

How often this cash flow occurs.

start_date: Option<String>

Optional start date. If None, starts from the first portfolio date.

end_date: Option<String>

Optional end date. If None, continues until the last portfolio date.

allocation: CashFlowAllocation

How the cash flow is distributed across assets.

Trait Implementations

impl Clone for ScheduledCashFlow

fn clone(&self) -> ScheduledCashFlow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScheduledCashFlow

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

Formats the value using the given formatter.