Skip to main content

SandboxExecutionClient

Struct SandboxExecutionClient 

Source
pub struct SandboxExecutionClient { /* private fields */ }
Expand description

A sandbox execution client for paper trading against live market data.

The SandboxExecutionClient simulates order execution using the OrderMatchingEngine to match orders against market data. This enables strategy testing in real-time without actual order execution on exchanges.

Implementations§

Source§

impl SandboxExecutionClient

Source

pub fn new( core: ExecutionClientCore, config: SandboxExecutionClientConfig, clock: Rc<RefCell<dyn Clock>>, cache: Rc<RefCell<Cache>>, ) -> Self

Creates a new SandboxExecutionClient instance.

Source

pub const fn config(&self) -> &SandboxExecutionClientConfig

Returns a reference to the configuration.

Source

pub fn matching_engine_count(&self) -> usize

Returns the number of active matching engines.

Source

pub fn process_quote_tick(&self, quote: &QuoteTick) -> Result<()>

Processes a quote tick through the matching engine.

§Errors

Returns an error if the instrument is not found in the cache.

Source

pub fn process_trade_tick(&self, trade: &TradeTick) -> Result<()>

Processes a trade tick through the matching engine.

§Errors

Returns an error if the instrument is not found in the cache.

Source

pub fn process_bar(&self, bar: &Bar) -> Result<()>

Processes a bar through the matching engine.

§Errors

Returns an error if the instrument is not found in the cache.

Source

pub fn process_order_book_deltas(&self, deltas: &OrderBookDeltas) -> Result<()>

Processes order book deltas through the matching engine.

§Errors

Returns an error if the instrument is not found in the cache.

Source

pub fn reset(&self)

Resets the sandbox to its initial state.

Trait Implementations§

Source§

impl Debug for SandboxExecutionClient

Source§

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

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

impl ExecutionClient for SandboxExecutionClient

Source§

fn is_connected(&self) -> bool

Source§

fn client_id(&self) -> ClientId

Source§

fn account_id(&self) -> AccountId

Source§

fn venue(&self) -> Venue

Source§

fn oms_type(&self) -> OmsType

Source§

fn get_account(&self) -> Option<AccountAny>

Source§

fn generate_account_state( &self, balances: Vec<AccountBalance>, margins: Vec<MarginBalance>, reported: bool, ts_event: UnixNanos, ) -> Result<()>

Generates and publishes the account state event. Read more
Source§

fn start(&mut self) -> Result<()>

Starts the execution client. Read more
Source§

fn stop(&mut self) -> Result<()>

Stops the execution client. Read more
Source§

fn connect<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Connects the client to the execution venue. Read more
Source§

fn disconnect<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Disconnects the client from the execution venue. Read more
Source§

fn submit_order(&self, cmd: &SubmitOrder) -> Result<()>

Submits a single order command to the execution venue. Read more
Source§

fn submit_order_list(&self, cmd: &SubmitOrderList) -> Result<()>

Submits a list of orders to the execution venue. Read more
Source§

fn modify_order(&self, cmd: &ModifyOrder) -> Result<()>

Modifies an existing order. Read more
Source§

fn cancel_order(&self, cmd: &CancelOrder) -> Result<()>

Cancels a specific order. Read more
Source§

fn cancel_all_orders(&self, cmd: &CancelAllOrders) -> Result<()>

Cancels all orders. Read more
Source§

fn batch_cancel_orders(&self, cmd: &BatchCancelOrders) -> Result<()>

Cancels a batch of orders. Read more
Source§

fn query_account(&self, _cmd: &QueryAccount) -> Result<()>

Queries the status of an account. Read more
Source§

fn query_order(&self, _cmd: &QueryOrder) -> Result<()>

Queries the status of an order. Read more
Source§

fn generate_order_status_report<'life0, 'life1, 'async_trait>( &'life0 self, _cmd: &'life1 GenerateOrderStatusReport, ) -> Pin<Box<dyn Future<Output = Result<Option<OrderStatusReport>>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generates a single order status report. Read more
Source§

fn generate_order_status_reports<'life0, 'life1, 'async_trait>( &'life0 self, _cmd: &'life1 GenerateOrderStatusReports, ) -> Pin<Box<dyn Future<Output = Result<Vec<OrderStatusReport>>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generates multiple order status reports. Read more
Source§

fn generate_fill_reports<'life0, 'async_trait>( &'life0 self, _cmd: GenerateFillReports, ) -> Pin<Box<dyn Future<Output = Result<Vec<FillReport>>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Generates fill reports based on execution results. Read more
Source§

fn generate_position_status_reports<'life0, 'life1, 'async_trait>( &'life0 self, _cmd: &'life1 GeneratePositionStatusReports, ) -> Pin<Box<dyn Future<Output = Result<Vec<PositionStatusReport>>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generates position status reports. Read more
Source§

fn generate_mass_status<'life0, 'async_trait>( &'life0 self, _lookback_mins: Option<u64>, ) -> Pin<Box<dyn Future<Output = Result<Option<ExecutionMassStatus>>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Generates mass status for executions. Read more
§

fn register_external_order( &self, _client_order_id: ClientOrderId, _venue_order_id: VenueOrderId, _instrument_id: InstrumentId, _strategy_id: StrategyId, _ts_init: UnixNanos, )

Registers an external order for tracking by the execution client. Read more

Auto Trait Implementations§

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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