nautilus_backtest::matching_engine

Struct OrderMatchingEngine

Source
pub struct OrderMatchingEngine {
    pub venue: Venue,
    pub instrument: InstrumentAny,
    pub raw_id: u32,
    pub book_type: BookType,
    pub oms_type: OmsType,
    pub account_type: AccountType,
    pub market_status: MarketStatus,
    pub config: OrderMatchingEngineConfig,
    /* private fields */
}
Expand description

An order matching engine for a single market.

Fields§

§venue: Venue

The venue for the matching engine.

§instrument: InstrumentAny

The instrument for the matching engine.

§raw_id: u32

The instruments raw integer ID for the venue.

§book_type: BookType

The order book type for the matching engine.

§oms_type: OmsType

The order management system (OMS) type for the matching engine.

§account_type: AccountType

The account type for the matching engine.

§market_status: MarketStatus

The market status for the matching engine.

§config: OrderMatchingEngineConfig

The config for the matching engine.

Implementations§

Source§

impl OrderMatchingEngine

Source

pub fn new( instrument: InstrumentAny, raw_id: u32, fill_model: FillModel, book_type: BookType, oms_type: OmsType, account_type: AccountType, clock: &'static AtomicTime, msgbus: Rc<RefCell<MessageBus>>, cache: Rc<RefCell<Cache>>, config: OrderMatchingEngineConfig, ) -> Self

Creates a new OrderMatchingEngine instance.

Source

pub fn reset(&mut self)

Source

pub fn set_fill_model(&mut self, fill_model: FillModel)

Source

pub fn best_bid_price(&self) -> Option<Price>

Source

pub fn best_ask_price(&self) -> Option<Price>

Source

pub const fn get_book(&self) -> &OrderBook

Source

pub fn get_open_bid_orders(&self) -> &[PassiveOrderAny]

Source

pub fn get_open_ask_orders(&self) -> &[PassiveOrderAny]

Source

pub fn get_open_orders(&self) -> Vec<PassiveOrderAny>

Source

pub fn order_exists(&self, client_order_id: ClientOrderId) -> bool

Source

pub fn process_order_book_delta(&mut self, delta: &OrderBookDelta)

Process the venues market for the given order book delta.

Source

pub fn process_order_book_deltas(&mut self, deltas: &OrderBookDeltas)

Source

pub fn process_quote_tick(&mut self, quote: &QuoteTick)

Source

pub fn process_bar(&mut self, bar: &Bar)

Source

pub fn process_trade_tick(&mut self, trade: &TradeTick)

Source

pub fn process_status(&mut self, action: MarketStatusAction)

Source

pub fn process_order(&mut self, order: &OrderAny, account_id: AccountId)

Source

pub fn iterate(&mut self, timestamp_ns: UnixNanos)

Iterate the matching engine by processing the bid and ask order sides and advancing time up to the given UNIX timestamp_ns.

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

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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