Skip to main content

EngineState

Struct EngineState 

Source
pub struct EngineState<GlobalData, InstrumentData> {
    pub trading: TradingState,
    pub global: GlobalData,
    pub connectivity: ConnectivityStates,
    pub assets: AssetStates,
    pub instruments: InstrumentStates<InstrumentData, ExchangeIndex, AssetIndex, InstrumentIndex>,
}
Expand description

Algorithmic trading Engine state.

Fields§

§trading: TradingState

Current TradingState of the Engine.

§global: GlobalData

Configurable GlobalData state.

§connectivity: ConnectivityStates

Global connection Health, and health of the market data and account connections for each exchange.

§assets: AssetStates

State of every asset (eg/ “btc”, “usdt”, etc.) being tracked by the Engine.

§instruments: InstrumentStates<InstrumentData, ExchangeIndex, AssetIndex, InstrumentIndex>

State of every instrument (eg/ “okx_spot_btc_usdt”, “bybit_perpetual_btc_usdt”, etc.) being tracked by the Engine.

Implementations§

Source§

impl<GlobalData, InstrumentData> EngineState<GlobalData, InstrumentData>

Source

pub const fn new( trading: TradingState, global: GlobalData, connectivity: ConnectivityStates, assets: AssetStates, instruments: InstrumentStates<InstrumentData, ExchangeIndex, AssetIndex, InstrumentIndex>, ) -> EngineState<GlobalData, InstrumentData>

Source§

impl<GlobalData, InstrumentData> EngineState<GlobalData, InstrumentData>

Source

pub fn builder<FnInstrumentData>( instruments: &IndexedInstruments, global: GlobalData, instrument_data_init: FnInstrumentData, ) -> EngineStateBuilder<'_, GlobalData, FnInstrumentData>
where FnInstrumentData: Fn(&Keyed<InstrumentIndex, Instrument<Keyed<ExchangeIndex, ExchangeId>, AssetIndex>>) -> InstrumentData,

Construct an EngineStateBuilder to assist with EngineState initialisation.

Source

pub fn update_from_account( &mut self, event: &AccountEvent, ) -> Option<PositionExited<QuoteAsset>>
where GlobalData: for<'a> Processor<&'a AccountEvent>, InstrumentData: for<'a> Processor<&'a AccountEvent>,

Updates the internal state from an AccountEvent.

If the AccountEvent results in a new PositionExited, that is returned.

This method:

  • Sets the account ConnectivityState to Health::Healthy if it was not previously.
  • Updates the GlobalData with the AccountEvent.
  • Updates the associated AssetStates and InstrumentStates with the AccountEvent.
Source

pub fn update_from_market( &mut self, event: &MarketEvent<InstrumentIndex, InstrumentData::MarketEventKind>, )
where GlobalData: for<'a> Processor<&'a MarketEvent<InstrumentIndex, InstrumentData::MarketEventKind>>, InstrumentData: InstrumentDataState,

Updates the internal state from a MarketEvent.

This method:

Trait Implementations§

Source§

impl<GlobalData: Clone, InstrumentData: Clone> Clone for EngineState<GlobalData, InstrumentData>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<GlobalData: Debug, InstrumentData: Debug> Debug for EngineState<GlobalData, InstrumentData>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, GlobalData, InstrumentData> Deserialize<'de> for EngineState<GlobalData, InstrumentData>
where GlobalData: Deserialize<'de>, InstrumentData: Deserialize<'de>,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<GlobalData, InstrumentData> From<&EngineState<GlobalData, InstrumentData>> for FnvHashMap<ExchangeId, UnindexedAccountSnapshot>

Source§

fn from(value: &EngineState<GlobalData, InstrumentData>) -> Self

Converts to this type from the input type.
Source§

impl<GlobalData, InstrumentData> InFlightRequestRecorder for EngineState<GlobalData, InstrumentData>

Source§

fn record_in_flight_cancel( &mut self, request: &OrderRequestCancel<ExchangeIndex, InstrumentIndex>, )

Source§

fn record_in_flight_open( &mut self, request: &OrderRequestOpen<ExchangeIndex, InstrumentIndex>, )

Source§

fn record_in_flight_cancels<'a>( &mut self, requests: impl IntoIterator<Item = &'a OrderRequestCancel<ExchangeKey, InstrumentKey>>, )
where ExchangeKey: 'a, InstrumentKey: 'a,

Source§

fn record_in_flight_opens<'a>( &mut self, requests: impl IntoIterator<Item = &'a OrderRequestOpen<ExchangeKey, InstrumentKey>>, )
where ExchangeKey: 'a, InstrumentKey: 'a,

Source§

impl<GlobalData: PartialEq, InstrumentData: PartialEq> PartialEq for EngineState<GlobalData, InstrumentData>

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<GlobalData, InstrumentData> Serialize for EngineState<GlobalData, InstrumentData>
where GlobalData: Serialize, InstrumentData: Serialize,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<GlobalData: PartialEq, InstrumentData: PartialEq> StructuralPartialEq for EngineState<GlobalData, InstrumentData>

Auto Trait Implementations§

§

impl<GlobalData, InstrumentData> Freeze for EngineState<GlobalData, InstrumentData>
where GlobalData: Freeze, InstrumentStates<InstrumentData>: Freeze,

§

impl<GlobalData, InstrumentData> RefUnwindSafe for EngineState<GlobalData, InstrumentData>
where GlobalData: RefUnwindSafe, InstrumentStates<InstrumentData>: RefUnwindSafe,

§

impl<GlobalData, InstrumentData> Send for EngineState<GlobalData, InstrumentData>
where GlobalData: Send, InstrumentStates<InstrumentData>: Send,

§

impl<GlobalData, InstrumentData> Sync for EngineState<GlobalData, InstrumentData>
where GlobalData: Sync, InstrumentStates<InstrumentData>: Sync,

§

impl<GlobalData, InstrumentData> Unpin for EngineState<GlobalData, InstrumentData>
where GlobalData: Unpin, InstrumentStates<InstrumentData>: Unpin,

§

impl<GlobalData, InstrumentData> UnsafeUnpin for EngineState<GlobalData, InstrumentData>
where GlobalData: UnsafeUnpin, InstrumentStates<InstrumentData>: UnsafeUnpin,

§

impl<GlobalData, InstrumentData> UnwindSafe for EngineState<GlobalData, InstrumentData>
where GlobalData: UnwindSafe, InstrumentStates<InstrumentData>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more