Struct Order 

pub struct Order { /* private fields */ }

Active order in the perpetual contract order book.

Exchange order book has a limited capacity of 2^16-1 orders, which requires an extensive reuse of order IDs, up to the point that within the order of execution of a single order request, the same order ID can be used for more than one order. For example, if a taker order partially matches and then gets placed, the matched maker order with order ID = 1 gets removed from the book (and thus vacates the ID), then taker order gets placed under the same order ID = 1.

So the state of order book and particular mapping between orders and their IDs is tied to a particular point in time and should be used with care.

Exchange does not support concept of client order IDs and does not store any externally-provided state with orders on-chain, but each order request emits provided Order::request_id() with it, which gets indexed and stored with the order, with the original request ID preserved as Order::client_order_id() but with the limitation that this data is available only from events, not from the original snapshot.

See crate::abi::dex::Exchange::OrderDesc for more details on particular order parameters and exchange behavior. This wrapper provides automatic conversion from exchnage fixed numeric types to decimal numbers.

Implementations

impl 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 Order

fn clone(&self) -> Order

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Order

impl Debug for Order

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

Formats the value using the given formatter.

impl Display for Order

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

Formats the value using the given formatter.

impl Tabled for Order

Available on crate feature display only.

const LENGTH: usize = 13

A length of fields and headers, which must be the same.

fn fields(&self) -> Vec<Cow<'_, str>>

Fields method must return a list of cells.

fn headers() -> Vec<Cow<'static, str>>

Headers must return a list of column names.