Struct CancelOrderRequestBuilder 

pub struct CancelOrderRequestBuilder { /* private fields */ }

Builder pattern implementation for constructing CancelOrderRequest instances.

This builder provides a fluent interface for constructing cancel order requests, ensuring that required fields are properly set before the request can be built.

Examples

Building a request to cancel a specific order

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");

Building a request to cancel all orders for an account

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

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

Implementations

impl CancelOrderRequestBuilder

pub fn new() -> CancelOrderRequestBuilder

Creates a new CancelOrderRequestBuilder with all fields initially unset.

Examples

use types::api::cancel_order::CancelOrderRequestBuilder;

let builder = CancelOrderRequestBuilder::new();

pub fn market<S>(self, market: S) -> CancelOrderRequestBuilder

where S: Into<String>,

Sets the market identifier for the cancel order request.

This is a required field that specifies which market the order to be canceled is in.

Arguments

• market - Any value that can be converted to a String (market identifier)

Examples

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

let builder = CancelOrderRequest::builder()
    .market("0x5efc5ad00c209baf4c5d77dfd1be18e8b50916e53adbe2142ae1b47af445303c");

pub fn account<S>(self, account: S) -> CancelOrderRequestBuilder

where S: Into<String>,

Sets the account identifier for the cancel order request.

This is a required field that specifies which account owns the order(s) to be canceled.

Arguments

• account - Any value that can be converted to a String (account identifier)

Examples

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

let builder = CancelOrderRequest::builder()
    .account("0x123");

pub fn order_id(self, order_id: u128) -> CancelOrderRequestBuilder

Sets the specific order ID to cancel (optional).

If this field is set, only the order with the specified ID will be canceled. If omitted and no client_order_id is set either, all orders for the account in the specified market are canceled.

Arguments

• order_id - The 128-bit unsigned integer ID of the specific order to cancel

Examples

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

let builder = CancelOrderRequest::builder()
    .order_id(12345678901234567890u128);

pub fn client_order_id<S>(self, client_order_id: S) -> CancelOrderRequestBuilder

where S: Into<String>,

Sets the client-assigned order ID to cancel (optional).

Alternative to order_id. If both are set, build() succeeds but the request fails validation. If neither is set, all orders for the account are canceled.

Arguments

• client_order_id - The client-assigned ID of the order to cancel

pub fn build(self) -> Result<CancelOrderRequest, CancelOrderRequestBuilderError>

Builds the CancelOrderRequest from the configured builder.

This method validates that all required fields have been set and constructs the final CancelOrderRequest instance.

Returns

• Ok(CancelOrderRequest) - Successfully built request
• Err(CancelOrderRequestBuilderError) - Missing required field(s)

Errors

Returns CancelOrderRequestBuilderError::MissingField if either the market or account fields have not been set.

Examples

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

// Successful build
let request = CancelOrderRequest::builder()
    .market("0x123")
    .account("0x123")
    .build()
    .expect("Failed to build request");

// Build error - missing required field
let result = CancelOrderRequest::builder()
    .market("0x123")
    // Missing account field
    .build();
assert!(result.is_err());

Trait Implementations

impl Debug for CancelOrderRequestBuilder

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

Formats the value using the given formatter.

impl Default for CancelOrderRequestBuilder

fn default() -> CancelOrderRequestBuilder

Returns the “default value” for a type.