Struct ConditionalExpiryBuilder 

pub struct ConditionalExpiryBuilder { /* private fields */ }

Builder for constructing ConditionalExpiry configurations with a fluent API.

This builder provides a type-safe way to create expiry configurations for conditional orders. When a conditional order reaches its expiry timestamp, it can either:

• Trigger immediately: go live regardless of the price condition, as the order type it was submitted with (a limit order stays a limit order)
• Cancel: Remove the order from the book

Required Fields

The following fields must be set before calling build():

• Timestamp: Unix timestamp (milliseconds since epoch) when expiry occurs
• Trigger action: Whether to trigger or cancel on expiry

Examples

Trigger order at expiry:

use types::api::submit_order::ConditionalExpiryBuilder;

let expiry = ConditionalExpiryBuilder::new()
    .timestamp(1747313713)
    .trigger_on_expiry()
    .build()
    .unwrap();

Cancel order at expiry:

use types::api::submit_order::ConditionalExpiryBuilder;

let expiry = ConditionalExpiryBuilder::new()
    .timestamp(1747313713)
    .cancel_on_expiry()
    .build()
    .unwrap();

Note: For simple cases, consider using the convenience methods ConditionalExpiry::trigger_at() or ConditionalExpiry::cancel_at() instead.

Implementations

impl ConditionalExpiryBuilder

pub fn new() -> ConditionalExpiryBuilder

Creates a new ConditionalExpiryBuilder with all fields unset.

Example

use types::api::submit_order::ConditionalExpiryBuilder;

let builder = ConditionalExpiryBuilder::new();

pub fn timestamp(self, timestamp: u128) -> ConditionalExpiryBuilder

Sets the Unix timestamp (milliseconds since epoch) when the expiry should occur.

Required field - Must be set before calling build().

Arguments

• timestamp - Unix timestamp in milliseconds (e.g., 1747313713000)

Example

use types::api::submit_order::ConditionalExpiryBuilder;

let builder = ConditionalExpiryBuilder::new()
    .timestamp(1747313713000);

pub fn trigger_on_expiry(self) -> ConditionalExpiryBuilder

Configures the order to go live when expiry is reached, price condition or not.

When the timestamp is reached the conditional is armed and submitted as an ordinary order — with the order_type and limit_price it was built with, not converted to a market order.

Required field - Must set either this or cancel_on_expiry().

Example

use types::api::submit_order::ConditionalExpiryBuilder;

let expiry = ConditionalExpiryBuilder::new()
    .timestamp(1747313713)
    .trigger_on_expiry()
    .build()
    .unwrap();

pub fn cancel_on_expiry(self) -> ConditionalExpiryBuilder

Configures the order to cancel when expiry is reached.

When the timestamp is reached, the conditional order will be removed from the order book without executing.

Required field - Must set either this or trigger_on_expiry().

Example

use types::api::submit_order::ConditionalExpiryBuilder;

let expiry = ConditionalExpiryBuilder::new()
    .timestamp(1747313713)
    .cancel_on_expiry()
    .build()
    .unwrap();

pub fn trigger(self, trigger: bool) -> ConditionalExpiryBuilder

Sets the trigger flag directly.

Tip: Consider using trigger_on_expiry() or cancel_on_expiry() for better readability.

Arguments

• trigger - true to trigger on expiry, false to cancel

pub fn build(self) -> Result<ConditionalExpiry, ConditionalExpiryBuilderError>

Builds the ConditionalExpiry, consuming the builder.

Returns

• Ok(ConditionalExpiry) - Successfully built expiry configuration
• Err(ConditionalExpiryBuilderError) - Missing required fields

Errors

Returns an error if either timestamp or trigger field is not set.

Example

use types::api::submit_order::ConditionalExpiryBuilder;

let expiry = ConditionalExpiryBuilder::new()
    .timestamp(1747313713)
    .trigger_on_expiry()
    .build()
    .expect("Failed to build expiry");

Trait Implementations

impl Debug for ConditionalExpiryBuilder

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

Formats the value using the given formatter.

impl Default for ConditionalExpiryBuilder

fn default() -> ConditionalExpiryBuilder

Returns the “default value” for a type.