Struct barter_data::subscription::book::OrderBook

pub struct OrderBook {
    pub last_update_time: DateTime<Utc>,
    pub bids: OrderBookSide,
    pub asks: OrderBookSide,
}

Normalised Barter OrderBook snapshot.

Fields

last_update_time: DateTime<Utc>

bids: OrderBookSide

asks: OrderBookSide

Implementations

impl OrderBook

pub fn snapshot(&mut self) -> Self

Generate an OrderBook snapshot by cloning Self after sorting each OrderBookSide.

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

Calculate the mid price by taking the average of the best bid and ask prices.

See Docs: https://www.quantstart.com/articles/high-frequency-trading-ii-limit-order-book

pub fn volume_weighed_mid_price(&self) -> Option<f64>

Calculate the volume weighted mid price (micro-price), weighing the best bid and ask prices with their associated amount.

See Docs: https://www.quantstart.com/articles/high-frequency-trading-ii-limit-order-book

Trait Implementations

impl Clone for OrderBook

fn clone(&self) -> OrderBook

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrderBook

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OrderBook

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

Deserialize this value from the given Serde deserializer.

impl From<BinanceOrderBookL2Snapshot> for OrderBook

fn from(snapshot: BinanceOrderBookL2Snapshot) -> Self

Converts to this type from the input type.

impl Ord for OrderBook

fn cmp(&self, other: &OrderBook) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<OrderBook> for OrderBook

fn eq(&self, other: &OrderBook) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<OrderBook> for OrderBook

fn partial_cmp(&self, other: &OrderBook) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for OrderBook

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

Serialize this value into the given Serde serializer.

impl Eq for OrderBook

impl StructuralEq for OrderBook

impl StructuralPartialEq for OrderBook