Struct ScenarioBuilder 

pub struct ScenarioBuilder { /* private fields */ }

Builder for creating scenarios.

Implementations

impl ScenarioBuilder

pub fn new(name: impl Into<String>) -> Self

Creates a new scenario builder.

pub const fn with_cash(self, cash: Decimal) -> Self

Sets the initial cash balance.

pub fn with_instrument( self, symbol: impl Into<String>, name: impl Into<String>, price: Decimal, lot_size: u32, ) -> Self

Adds an instrument.

pub fn with_position( self, symbol: impl Into<String>, quantity: Decimal, price: Decimal, ) -> Self

Adds an initial position.

pub fn with_target(self, symbol: impl Into<String>, percent: Decimal) -> Self

Sets a target allocation percentage.

pub fn with_price_model( self, symbol: impl Into<String>, model: PriceModel, ) -> Self

Sets the price model for an instrument.

pub const fn with_ticks(self, ticks: usize) -> Self

Sets the number of ticks to simulate.

pub const fn with_rebalance_interval(self, interval: usize) -> Self

Sets the rebalance interval.

pub fn dry_run(self) -> Self

Sets the balancer to dry run mode.

pub fn assert(self, assertion: ScenarioAssertion) -> Self

Adds an assertion.

pub fn assert_min_value(self, value: Decimal) -> Self

Asserts minimum portfolio value.

pub fn assert_min_return(self, percent: Decimal) -> Self

Asserts minimum return percentage.

pub fn assert_max_trades(self, max: usize) -> Self

Asserts maximum number of trades.

pub fn build(self) -> Scenario

Builds the scenario.