Skip to main content

OrderBook

Struct OrderBook 

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

Live order book for a single symbol.

Implementations§

Source§

impl OrderBook

Source

pub fn new(symbol: impl Into<String>) -> Self

Source

pub fn apply(&mut self, delta: BookDelta) -> Result<(), StreamError>

Apply an incremental delta. quantity == 0 removes the level.

Source

pub fn reset( &mut self, bids: Vec<PriceLevel>, asks: Vec<PriceLevel>, ) -> Result<(), StreamError>

Reset the book from a full snapshot.

Source

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

Best bid (highest).

Source

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

Best ask (lowest).

Source

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

Mid price.

Source

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

Spread.

Source

pub fn bid_depth(&self) -> usize

Number of bid levels.

Source

pub fn ask_depth(&self) -> usize

Number of ask levels.

Source

pub fn symbol(&self) -> &str

Source

pub fn last_sequence(&self) -> Option<u64>

Source

pub fn top_bids(&self, n: usize) -> Vec<PriceLevel>

Top N bids (descending by price).

Source

pub fn top_asks(&self, n: usize) -> Vec<PriceLevel>

Top N asks (ascending by price).

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.

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