Struct cxmr_orderbook::OrderBook

pub struct OrderBook {
    pub last_update: u64,
    // some fields omitted
}

Exchange Order book.

Fields

last_update: u64

Timestamp of last update.

Methods

impl OrderBook

pub fn asks(&self) -> &OrderBookSide<u64>

Returns ask side of the orderbook.

pub fn bids(&self) -> &OrderBookSide<ReverseRate>

Returns bid side of the orderbook.

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

Calculates bid-ask spread percentage relational to bid rate.

pub fn spread_nth(&self, n: usize) -> Option<f64>

Calculates bid-ask spread percentage relational to bid rate.

pub fn update<'a, I>(&mut self, events: I) where
    I: Iterator<Item = &'a Event>, 

Updates orderbook from events reference.

pub fn consume(&mut self, ev: Events) -> Result<Events, Error>

Consumes events to update orderbook. Returns events with orderbook events flattened.

pub fn consume_events(&mut self, events: Vec<Event>) -> Vec<Event>

Consumes events to update orderbook. Returns events with orderbook events flattened.

pub fn consume_event(&mut self, event: Event) -> Vec<Event>

Consumes event to update orderbook. Returns events with orderbook events flattened.

pub fn update_from_event(&mut self, event: &Event)

Updates orderbook from a single event.

pub fn update_from_rows(&mut self, events: &[EventData])

Updates orderbook from data rows.

pub fn update_from_row(&mut self, event: &EventData)

Updates orderbook from a single event.

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

fn default() -> Self

Returns the "default value" for a type.

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<&'_ OrderBook> for OrderBook

fn from(book: &OrderBook) -> OrderBook

Performs the conversion.

impl<'_> From<&'_ OrderBook> for Vec<EventData>

fn from(book: &OrderBook) -> Vec<EventData>

Performs the conversion.

impl<'_> From<&'_ OrderBook> for Event

fn from(book: &OrderBook) -> Event

Performs the conversion.

impl<'a> From<&'a [EventData]> for OrderBook

fn from(events: &'a [EventData]) -> Self

Performs the conversion.

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: &OrderBook) -> bool

This method tests for !=.

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