Skip to main content

OrderBook

Struct OrderBook 

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

L3 order book with intrusive linked lists.

Orders are stored in a HashMap keyed by OrderId, with each price level maintaining a doubly-linked list of orders in FIFO (time-priority) order. Provides both L2 (aggregated price levels) and L3 (individual orders) views.

Implementations§

Source§

impl OrderBook

Source

pub fn asks(&self) -> &BTreeMap<UD64, BookLevel>

Asks sorted away from the spread.

Source

pub fn bids(&self) -> &BTreeMap<Reverse<UD64>, BookLevel>

Bids sorted away from the spread.

Source

pub fn best_ask(&self) -> Option<(UD64, UD64)>

Best ask price/size.

Source

pub fn best_bid(&self) -> Option<(UD64, UD64)>

Best bid price/size.

Source

pub fn ask_impact(&self, want_size: UD64) -> Option<(UD64, UD64, UD64)>

Ask impact price for the requested size, along with the fillable size and size-averaged price.

Source

pub fn bid_impact(&self, want_size: UD64) -> Option<(UD64, UD64, UD64)>

Bid impact price for the requested size, along with the fillable size and size-averaged price.

Source

pub fn ask_impact_notional( &self, want_notional: UD128, ) -> Option<(UD64, UD64, UD64, UD128)>

Ask impact price for the requested notional amount, along with the fillable size, size-averaged price, and filled notional. CAREFUL: See impact_notional for partial-fill semantics.

Source

pub fn bid_impact_notional( &self, want_notional: UD128, ) -> Option<(UD64, UD64, UD64, UD128)>

Bid impact price for the requested notional amount, along with the fillable size, size-averaged price, and filled notional. CAREFUL: See impact_notional for partial-fill semantics.

Source

pub fn ask_level(&self, price: UD64) -> Option<&BookLevel>

Get L3 level at a specific ask price.

Source

pub fn bid_level(&self, price: UD64) -> Option<&BookLevel>

Get L3 level at a specific bid price.

Source

pub fn get_order(&self, order_id: OrderId) -> Option<&BookOrder>

Get a specific order by ID (O(1) via HashMap lookup).

Source

pub fn get_order_by_client_id( &self, account_id: AccountId, client_id: RequestId, ) -> Option<&BookOrder>

Get a specific order by client order ID (O(1) via HashMap lookup).

Source

pub fn ask_orders(&self) -> impl Iterator<Item = &BookOrder>

Iterator over all L3 orders on the ask side in price-time priority.

Source

pub fn bid_orders(&self) -> impl Iterator<Item = &BookOrder>

Iterator over all L3 orders on the bid side in price-time priority.

Source

pub fn total_orders(&self) -> usize

Total number of orders in the book.

Source

pub fn all_orders(&self) -> &HashMap<OrderId, BookOrder>

Access to all orders in the book keyed by order ID.

Source

pub fn view<'a>( &'a self, depth: Option<usize>, orders_per_level: Option<usize>, show_expired: bool, ) -> OrderBookView<'a>

Trait Implementations§

Source§

impl Clone for OrderBook

Source§

fn clone(&self) -> OrderBook

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 Debug for OrderBook

Source§

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

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

impl Default for OrderBook

Source§

fn default() -> OrderBook

Returns the “default value” for a type. Read more
Source§

impl Display for OrderBook

Available on crate feature display only.
Source§

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

Formats the value using the given formatter. 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<U> As for U

Source§

fn as_<T>(self) -> T
where T: CastFrom<U>, U: Sized,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. 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> 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

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