Struct BookOrder 

pub struct BookOrder { /* private fields */ }

Individual order in the book with linked list pointers.

Each order belongs to a doubly-linked list at its price level, enabling O(1) insertion/removal and natural FIFO ordering.

Implementations

impl BookOrder

pub fn new(order: Order) -> Self

Create a new book order (initially unlinked).

Methods from Deref<Target = Order>

pub fn instant(&self) -> StateInstant

Instant the order state is consistent with or was last updated at.

pub fn request_id(&self) -> Option<RequestId>

ID of the request this order was posted or updated by. Available only from real-time events, not from the initial snapshot.

pub fn client_order_id(&self) -> Option<RequestId>

Client order ID = ID of the request this order was placed by. Available only from real-time events, not from the initial snapshot.

pub fn order_id(&self) -> OrderId

ID of the order in the book.

pub fn type(&self) -> OrderType

Type of the order.

pub fn account_id(&self) -> AccountId

ID of the account issued the order.

pub fn price(&self) -> UD64

Limit price of the order.

pub fn size(&self) -> UD64

Current size of the order.

pub fn placed_size(&self) -> Option<UD64>

Size of the order that was placed. Available only from real-time events, not from the initial snapshot.

pub fn filled_size(&self) -> Option<UD64>

Filled size of the order. Available only from real-time events, not from the initial snapshot.

pub fn expiry_block(&self) -> u64

Expiry block of the order, zero if was not specified.

pub fn is_expired(&self) -> bool

Check if the order is expired. NOTE: Valid only after the end of expiry block processing.

pub fn leverage(&self) -> UD64

Leverage of the order.

pub fn post_only(&self) -> Option<bool>

Post-only flag. Available only from real-time events, not from the initial snapshot.

pub fn fill_or_kill(&self) -> Option<bool>

Fill-or-fill flag. Available only from real-time events, not from the initial snapshot.

pub fn immediate_or_cancel(&self) -> Option<bool>

Immediate-or-cancel flag. Available only from real-time events, not from the initial snapshot.

pub fn builder(&self) -> Option<BuilderAttribution>

Builder the order is attributed to, along with the additive fee rate that builder charges on the size the order adds. None means no builder.

Unlike the flags above, attribution is persisted with the resting order on-chain, so it is available both from the initial snapshot (contract v1.1.7.4+, via getOrderV2) and from the OrderRequestV2 event stream. What a builder actually earned per fill is reported by the builder_fee of super::OrderEventType::Filled.

pub fn prev_order_id(&self) -> Option<OrderId>

Previous order ID in the FIFO queue at this price level. Available from snapshot, None for newly placed orders or if this is the first order.

pub fn next_order_id(&self) -> Option<OrderId>

Next order ID in the FIFO queue at this price level. Available from snapshot, None for newly placed orders or if this is the last order.

Trait Implementations

impl Clone for BookOrder

fn clone(&self) -> BookOrder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BookOrder

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

Formats the value using the given formatter.

impl Deref for BookOrder

type Target = Order

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for BookOrder

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.