pub struct MockExchange {
pub venue: SimulatedVenue,
pub latency_ms: u64,
pub request_rx: UnboundedReceiver<MockExchangeRequest>,
pub event_tx: Sender<UnindexedAccountEvent>,
/* private fields */
}Expand description
Asynchronous driver for a SimulatedVenue: channels, simulated latency, emission ordering.
It owns no ledger and prices nothing. What the venue models, what it rejects and what it leaves
unaccounted for are documented on SimulatedVenue; this type decides only when the venue’s
output reaches a client.
It drives a venue in one of two VenueRegimes:
new: request-priced, for a backtest that sends one request at a time. A market order is priced from the snapshot its request carries, and nothing can rest.new_market_driven: fed a live market, for paper trading. Limit orders rest and fill as the market crosses them, as in a backtest of the same venue.
§Ordering
Everything the venue produces — account events and every response, fetches included — is queued
in the order the venue produced it and drained by a single task, so emission order equals
booking order. A response is emitted after the account events produced before it, so a client
holding a response has already been sent every event the venue booked ahead of it. Closing
request_rx closes that queue in turn, and run returns only once it has drained.
Fields§
§venue: SimulatedVenueThe venue’s state machine. Ledger, pricing and ordering obligations live here.
latency_ms: u64Simulated round-trip delay. Transport policy, so it lives on the driver, not the venue.
request_rx: UnboundedReceiver<MockExchangeRequest>§event_tx: Sender<UnindexedAccountEvent>Implementations§
Source§impl MockExchange
impl MockExchange
Sourcepub fn new(
config: MockExecutionConfig,
request_rx: UnboundedReceiver<MockExchangeRequest>,
event_tx: Sender<UnindexedAccountEvent>,
instruments: FnvHashMap<InstrumentNameExchange, Instrument<ExchangeId, AssetNameExchange>>,
) -> Self
pub fn new( config: MockExecutionConfig, request_rx: UnboundedReceiver<MockExchangeRequest>, event_tx: Sender<UnindexedAccountEvent>, instruments: FnvHashMap<InstrumentNameExchange, Instrument<ExchangeId, AssetNameExchange>>, ) -> Self
A request-priced driver, building its venue from config with SimulatedVenue::new.
Each request is booked when it is received, at its own time_request plus half of
latency_ms, and its output is emitted latency_ms of real time later.
Sourcepub fn new_market_driven(
venue: SimulatedVenue,
latency_ms: u64,
request_rx: UnboundedReceiver<MockExchangeRequest>,
event_tx: Sender<UnindexedAccountEvent>,
feed: BoxStream<'static, MarketFeedEvent>,
clock: MockExchangeClock,
) -> Self
pub fn new_market_driven( venue: SimulatedVenue, latency_ms: u64, request_rx: UnboundedReceiver<MockExchangeRequest>, event_tx: Sender<UnindexedAccountEvent>, feed: BoxStream<'static, MarketFeedEvent>, clock: MockExchangeClock, ) -> Self
A driver that runs venue on a live market: feed supplies the market, and clock the
time everything is stamped with.
§Time
The venue is stamped from clock, held so that it never moves backwards: an instant before
the latest one already stamped is stamped with that latest one instead. A request’s own
time_request is not used. The clock is moved to clock’s instant when run
starts, so interest and holding costs accrue from then, and on each venue deadline (an
order’s expiry, a holding-cost or interest boundary) when it falls, whether or not anything
else arrives.
§Latency, as in a backtest of the same venue
A request waits half of latency_ms of real time before it is booked, against the market
held at that moment, and its output is emitted half of latency_ms after that. A fill the
market causes on a resting order pays the second half alone. Integer division drops an odd
millisecond from each half.
§Market input
Each MarketFeedEvent::Observation is applied with SimulatedVenue::apply_market as it
arrives, ahead of a request that is due at the same moment. An instrument the feed has not
yet observed refuses a market order, while a limit order on it rests.
When the feed reports MarketFeedEvent::Lagged, the driver logs an error and emits a
StreamTerminated after everything queued
before it, which ends the account stream of a MockExecution
client. The venue keeps running, and nothing it booked is lost: a client that reopens the
stream can read its fills back. What the dropped observations showed is lost, so a resting
order may have missed a fill. Fill recovery cannot repair that.
When the feed ends, the driver logs a warning and serves requests on the last market it saw. Deadlines keep falling.
The feed is served ahead of requests, so while it has a backlog a request is read, and its wait for the venue begins, only after that backlog is applied. The latency above is a lower bound. The backlog is bounded by the feed’s own buffer.
§Panics
If venue is not VenueRegime::MarketDriven: a request-priced venue does not price from
the feed, so feeding it would change nothing.
Sourcepub async fn run(self)
pub async fn run(self)
Serves requests until the request channel closes, then lets queued output finish.
Venue output is not emitted inline: it is queued and drained by a single task, so that emission order equals booking order. Closing the request channel closes that queue in turn, and this method returns only once the queue has drained, so shutting the venue down cannot strand a fill the client is still waiting on. A market-driven driver first books the requests still waiting out their latency.
pub fn account_stream(&self) -> BoxStream<'static, UnindexedAccountEvent>
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for MockExchange
impl !Sync for MockExchange
impl !UnwindSafe for MockExchange
impl Freeze for MockExchange
impl Send for MockExchange
impl Unpin for MockExchange
impl UnsafeUnpin for MockExchange
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreimpl<T> JsonSchemaMaybe for T
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.