Struct Order 

pub struct Order {
    pub id: Option<OrderId>,
    pub order_type: OrderType,
    pub quantity: Quantity,
    pub side: OrderSide,
    pub symbol: Symbol,
}

A trading order in the Central Limit Order Book.

Example

use clob_sync::order::{Order, OrderType, OrderSide, Quantity, Price, Symbol};
use fastnum::D128 as Dec;
use fastnum::decimal::Context;
use std::str::FromStr;

let order = Order::new(
    OrderType::Limit(Price::try_from("50000.50").unwrap()),
    Quantity::try_from("1.5").unwrap(),
    OrderSide::Buy,
    Symbol::from("BTC-USD"),
);

Fields

id: Option<OrderId>

order_type: OrderType

quantity: Quantity

side: OrderSide

symbol: Symbol

Implementations

impl Order

pub fn new( order_type: OrderType, quantity: Quantity, side: OrderSide, symbol: Symbol, ) -> Order

Creates a new order without an ID. The order must be assigned an ID before it can be executed.

Arguments

• order_type - The type of order (Limit or Market)
• quantity - The quantity to trade
• side - Whether this is a Buy or Sell order
• symbol - The trading symbol (e.g., “BTC-USD”)

Example

use clob_sync::order::{Order, OrderType, OrderSide, Quantity, Price, Symbol};
use fastnum::D128 as Dec;
use fastnum::decimal::Context;
use std::str::FromStr;

let order = Order::new(
    OrderType::Limit(Price::try_from("50000.00").unwrap()),
    Quantity::from(1u64),
    OrderSide::Buy,
    Symbol::from("BTC-USD"),
);
assert!(order.id.is_none());

pub fn with_id(self) -> Self

Assigns a time-based UUIDv7 order ID to this order.

UUIDv7 guarantees monotonic ordering within the same millisecond, making it suitable for order priority determination.

Example

use clob_sync::order::{Order, OrderType, OrderSide, Quantity, Price, Symbol};
use fastnum::D128 as Dec;
use fastnum::decimal::Context;
use std::str::FromStr;

let mut order = Order::new(
    OrderType::Limit(Price::try_from("50000.00").unwrap()),
    Quantity::from(1u64),
    OrderSide::Buy,
    Symbol::from("BTC-USD"),
);
order = order.with_id();
assert!(order.id.is_some());

pub fn get_id(&self) -> OrderId

Returns the order ID.

Panics

Panics if the order has not been assigned an ID via with_id.

Example

use clob_sync::order::{Order, OrderType, OrderSide, Quantity, Price, Symbol};
use fastnum::D128 as Dec;
use fastnum::decimal::Context;
use std::str::FromStr;

let order = Order::new(
    OrderType::Limit(Price::try_from("50000.00").unwrap()),
    Quantity::from(1u64),
    OrderSide::Buy,
    Symbol::from("BTC-USD"),
).with_id();

let _id = order.get_id();

pub fn with_reduced_quantity(&self, quantity: &Quantity) -> Order

Creates a new order with the quantity reduced by the specified amount.

This is useful when an order is partially filled and the remaining quantity needs to be tracked.

Arguments

• quantity - The quantity to subtract from this order’s quantity

Example

use clob_sync::order::{Order, OrderType, OrderSide, Quantity, Price, Symbol};
use fastnum::D128 as Dec;
use fastnum::decimal::Context;
use std::str::FromStr;

let order = Order::new(
    OrderType::Limit(Price::try_from("50000.00").unwrap()),
    Quantity::try_from("10.0").unwrap(),
    OrderSide::Buy,
    Symbol::from("BTC-USD"),
);

let remaining = order.with_reduced_quantity(&Quantity::try_from("3.0").unwrap());
assert_eq!(remaining.quantity, Quantity::try_from("7.0").unwrap());

impl Order

pub fn with_quantity(&self, quantity: Quantity) -> 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 Debug for Order

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

Formats the value using the given formatter.

impl Ord for Order

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Order

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Order

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Order

impl StructuralPartialEq for Order