LocalOrderBook

Struct LocalOrderBook 

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

Local view of an order book backed by sorted price levels.

Implementations§

Source§

impl LocalOrderBook

Source

pub fn new() -> Self

Create an empty order book.

Source

pub fn load_snapshot( &mut self, bids: &[(Price, Quantity)], asks: &[(Price, Quantity)], )

Reset the book with explicit bid/ask snapshots.

Source

pub fn add_order(&mut self, side: Side, price: Price, quantity: Quantity)

Insert or update a price level by accumulating quantity.

Source

pub fn apply_delta(&mut self, side: Side, price: Price, quantity: Quantity)

Overwrite a price level with the provided absolute quantity (removing when zero).

Source

pub fn apply_deltas( &mut self, bids: &[(Price, Quantity)], asks: &[(Price, Quantity)], )

Apply a batch of bid/ask deltas atomically.

Source

pub fn remove_order(&mut self, side: Side, price: Price, quantity: Quantity)

Remove quantity from a price level, deleting the level when depleted.

Source

pub fn clear_level(&mut self, side: Side, price: Price)

Remove an entire price level regardless of resting quantity.

Source

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

Best bid price/quantity currently stored.

Source

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

Best ask price/quantity currently stored.

Source

pub fn bids(&self) -> impl Iterator<Item = (Price, Quantity)> + '_

Iterate bids in descending price order.

Source

pub fn asks(&self) -> impl Iterator<Item = (Price, Quantity)> + '_

Iterate asks in ascending price order.

Source

pub fn take_liquidity( &mut self, aggressive_side: Side, quantity: Quantity, ) -> Vec<(Price, Quantity)>

Consume liquidity from the opposite side of an aggressive order.

Source

pub fn is_empty(&self) -> bool

Returns true when either side of the book currently holds levels.

Source

pub fn checksum(&self, depth: usize) -> u32

Compute a CRC32 checksum for the top N levels (Bybit/Binance compatibility).

Source

pub fn bid_levels(&self, depth: usize) -> Vec<(Price, Quantity)>

Helper for generating owned bid levels up to the desired depth.

Source

pub fn ask_levels(&self, depth: usize) -> Vec<(Price, Quantity)>

Helper for generating owned ask levels up to the desired depth.

Source

pub fn volume_at_level(&self, side: Side, price: Price) -> Quantity

Returns the total resting quantity at an exact price level.

Trait Implementations§

Source§

impl Clone for LocalOrderBook

Source§

fn clone(&self) -> LocalOrderBook

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

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LocalOrderBook

Source§

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

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

impl Default for LocalOrderBook

Source§

fn default() -> LocalOrderBook

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

impl<'de> Deserialize<'de> for LocalOrderBook

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for LocalOrderBook

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> 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.

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,