Struct OrderBook

Source
#[repr(align(64))]
pub struct OrderBook<const N: usize = 64> { pub symbol: String, pub exchange_timestamp_ns: u64, pub system_timestamp_ns: u64, pub bids: SmallVec<[PriceLevel; N]>, pub asks: SmallVec<[PriceLevel; N]>, }
Expand description

Order book data structure with const generic capacity

Fields§

§symbol: String

The trading symbol.

§exchange_timestamp_ns: u64

Nanosecond precision from exchange.

§system_timestamp_ns: u64

Nanosecond precision local time.

§bids: SmallVec<[PriceLevel; N]>

Must be initiated as sorted for binary search optimizations!

§asks: SmallVec<[PriceLevel; N]>

Must be initiated as sorted for binary search optimizations!

Implementations§

Source§

impl<const N: usize> OrderBook<N>

Source

pub fn new( symbol: impl AsRef<str>, exchange_timestamp_ns: u64, system_timestamp_ns: u64, bids: SmallVec<[PriceLevel; N]>, asks: SmallVec<[PriceLevel; N]>, ) -> Self

Create a new order book

Source

pub fn from_iters<B, A>( symbol: impl AsRef<str>, exchange_timestamp_ns: u64, system_timestamp_ns: u64, bids: B, asks: A, ) -> Self
where B: IntoIterator<Item = PriceLevel>, A: IntoIterator<Item = PriceLevel>,

Create a new order book from iterators (for compatibility and zero-copy)

Source

pub fn new_empty(instrument_id: InstrumentId) -> Self

Create an empty order book from instrument ID

Source

pub fn bids(&self) -> &[PriceLevel]

Get the bid levels

Source

pub fn asks(&self) -> &[PriceLevel]

Get the ask levels

Source

pub fn best_bid(&self) -> Option<&PriceLevel>

Get the best bid price

Source

pub fn best_ask(&self) -> Option<&PriceLevel>

Get the best ask price

Source

pub fn spread(&self) -> Option<Decimal>

Get the spread

Source

pub fn add_bid(&mut self, price: Decimal, quantity: Decimal)

Add a bid level

Source

pub fn add_ask(&mut self, price: Decimal, quantity: Decimal)

Add an ask level

Source

pub fn remove_bid(&mut self, price: Decimal)

Remove a bid level

Source

pub fn remove_ask(&mut self, price: Decimal)

Remove an ask level

Source

pub fn apply_snapshot(&mut self, snapshot: OrderBookSnapshot<N>)

Apply a snapshot to the order book This replaces the current state with the snapshot data

Trait Implementations§

Source§

impl<const N: usize> Clone for OrderBook<N>

Source§

fn clone(&self) -> OrderBook<N>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<const N: usize> Debug for OrderBook<N>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<const N: usize> Freeze for OrderBook<N>

§

impl<const N: usize> RefUnwindSafe for OrderBook<N>

§

impl<const N: usize> Send for OrderBook<N>

§

impl<const N: usize> Sync for OrderBook<N>

§

impl<const N: usize> Unpin for OrderBook<N>

§

impl<const N: usize> UnwindSafe for OrderBook<N>

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

§

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

impl<T> ErasedDestructor for T
where T: 'static,