Struct EngineStateBuilder 

pub struct EngineStateBuilder<'a, GlobalData, FnInstrumentData> { /* private fields */ }

Builder utility for an EngineState instance.

Implementations

impl<'a, GlobalData, FnInstrumentData> EngineStateBuilder<'a, GlobalData, FnInstrumentData>

pub fn new( instruments: &'a IndexedInstruments, global: GlobalData, instrument_data_init: FnInstrumentData, ) -> Self

Construct a new EngineStateBuilder with a layout derived from IndexedInstruments.

Note that the rest of the EngineState data can be generated from defaults if that is all that is needed.

Note that ConnectivityStates will be generated with generate_empty_indexed_connectivity_states, defaulting to Health::Reconnecting.

pub fn trading_state(self, value: TradingState) -> Self

Optionally provide the initial TradingState.

Defaults to TradingState::Disabled.

pub fn time_engine_start(self, value: DateTime<Utc>) -> Self

Optionally provide the time_engine_start.

Providing this is useful for back-test scenarios where the time should be seeded with a “historical” clock time (eg/ from first historical MarketEvent).

Defaults to Utc::now

pub fn balances<BalanceIter, KeyedBalance>(self, balances: BalanceIter) -> Self

where BalanceIter: IntoIterator<Item = KeyedBalance>, KeyedBalance: Into<Keyed<ExchangeAsset<AssetNameInternal>, Balance>>,

Optionally provide initial exchange asset Balances.

Useful for back-test scenarios where seeding EngineState with initial Balances is required.

Note the internal implementation uses a HashMap, so duplicate ExchangeAsset<AssetNameInternal> keys are overwritten.

pub fn build<InstrumentData>(self) -> EngineState<GlobalData, InstrumentData>

where FnInstrumentData: Fn(&'a Keyed<InstrumentIndex, Instrument<Keyed<ExchangeIndex, ExchangeId>, AssetIndex>>) -> InstrumentData,

Use the builder data to generate the associated EngineState.

If optional data is not provided (eg/ Balances), default values are used (eg/ zero Balance).

Trait Implementations

impl<'a, GlobalData: Clone, FnInstrumentData: Clone> Clone for EngineStateBuilder<'a, GlobalData, FnInstrumentData>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, GlobalData: Debug, FnInstrumentData: Debug> Debug for EngineStateBuilder<'a, GlobalData, FnInstrumentData>

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

Formats the value using the given formatter.