Struct CancelOrderRequest 

pub struct CancelOrderRequest {
    pub market: Arc<str>,
    pub market_id: MarketId,
    pub account: Arc<str>,
    pub account_id: AccountId,
    pub order_id: Option<u128>,
    pub client_order_id: Option<Arc<str>>,
}

Request to cancel an existing order in the matching engine.

This structure represents a request to cancel one or more orders for a specific account in a given market. Naming an order — by order_id or by client_order_id — cancels only that one. Only when both are absent does the request cancel every order the account holds in the market.

Field Aliases

The structure supports shorter field aliases for efficient serialization:

• market can be aliased as m
• account can be aliased as sa
• order_id can be aliased as oid
• client_order_id can be aliased as cid

Order ID Format

The order_id field accepts both string and numeric representations, supporting very large numbers (up to 128-bit integers) which may exceed JSON’s native number precision.

Examples

Cancel a specific order using full field names

{
  "market": "0x5efc5ad00c209baf4c5d77dfd1be18e8b50916e53adbe2142ae1b47af445303c",
  "account": "0xcc6ebf909253ea35314bb28d91321f6415827c01790fba84aaf570c87372850a",
  "order_id": "340282366920938463463374607431768211455"
}

Cancel a specific order using field aliases

{
  "m": "0x5efc5ad00c209baf4c5d77dfd1be18e8b50916e53adbe2142ae1b47af445303c",
  "sa": "0xcc6ebf909253ea35314bb28d91321f6415827c01790fba84aaf570c87372850a",
  "oid": 12345678901234567890
}

Cancel one order by the client id it was submitted with

{
  "market": "0x5efc5ad00c209baf4c5d77dfd1be18e8b50916e53adbe2142ae1b47af445303c",
  "account": "0xcc6ebf909253ea35314bb28d91321f6415827c01790fba84aaf570c87372850a",
  "client_order_id": "my-exit-001"
}

Cancel every order for the account in the market (omit both ids)

{
  "market": "0x5efc5ad00c209baf4c5d77dfd1be18e8b50916e53adbe2142ae1b47af445303c",
  "account": "0xcc6ebf909253ea35314bb28d91321f6415827c01790fba84aaf570c87372850a"
}

Validation

The request will be validated to ensure:

• The market field is not empty and the market exists (201 / 202)
• The account field is not empty (203)
• order_id and client_order_id are not both set (204)

Fields

market: Arc<str>

The market identifier where the order should be canceled.

This field is required and must match an existing market in the system. Can be provided using the alias “m” for compact serialization.

market_id: MarketId

account: Arc<str>

The account identifier that owns the order(s) to be canceled.

This field is required and identifies which account’s orders should be canceled. Can be provided using the alias “sa” for compact serialization.

account_id: AccountId

order_id: Option<u128>

Optional specific order ID to cancel.

If provided, only the order with this specific ID will be canceled. If omitted (None), all orders for the account in the specified market will be canceled.

Accepts both string and numeric formats to handle large 128-bit integers that may exceed JSON’s native number precision. Can be provided using the alias “oid”.

client_order_id: Option<Arc<str>>

Optional client-assigned order ID to cancel.

Alternative to order_id: if provided, the order the client tagged with this id will be canceled. Mutually exclusive with order_id — supplying both is a validation error. Can be provided using the alias “cid”.

Implementations

impl CancelOrderRequest

pub fn builder() -> CancelOrderRequestBuilder

Creates a new builder for constructing a CancelOrderRequest.

This is the recommended way to create new CancelOrderRequest instances, as it ensures all required fields are properly validated before construction.

Returns

A new CancelOrderRequestBuilder instance

Examples

use types::api::cancel_order::CancelOrderRequest;

let request = CancelOrderRequest::builder()
    .market("0x123")
    .account("0x123")
    .order_id(12345678901234567890u128)
    .build()
    .expect("Failed to build cancel order request");

Trait Implementations

impl Clone for CancelOrderRequest

fn clone(&self) -> CancelOrderRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancelOrderRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CancelOrderRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CancelOrderRequest> for Command

fn from(value: CancelOrderRequest) -> Command

Converts to this type from the input type.

impl Serialize for CancelOrderRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.