Struct BracketOrderResult 

#[non_exhaustive]
pub struct BracketOrderResult {
    pub parent: Order<ExchangeId, InstrumentNameExchange, UnindexedOrderState>,
    pub take_profit: Option<Order<ExchangeId, InstrumentNameExchange, UnindexedOrderState>>,
    pub stop_loss: Option<Order<ExchangeId, InstrumentNameExchange, UnindexedOrderState>>,
}

Result of bracket order placement.

Contains the parent order and optionally the child legs. The Option types document API divergence between exchanges:

Exchange	take_profit	stop_loss	Reason
IBKR	Some(...)	Some(...)	Returns all three orders immediately
Alpaca	None	None	Child legs created server-side; use fetch_open_orders

Invariants

• Either all orders are Active(Open) or all are Inactive (placement failed). Partial success is prevented by all-or-nothing error handling in implementations.
• Child legs are either both Some (exchange returns legs immediately, e.g. IBKR) or both None (exchange creates legs server-side, e.g. Alpaca). Asymmetric leg presence is not supported — no current exchange returns one leg but not the other, so with_all_legs and parent_only are the only public constructors.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

parent: Order<ExchangeId, InstrumentNameExchange, UnindexedOrderState>

Parent (entry) order.

take_profit: Option<Order<ExchangeId, InstrumentNameExchange, UnindexedOrderState>>

Take-profit order (opposite side, limit).

None when the exchange creates legs server-side (Alpaca). Some when the exchange returns legs immediately (IBKR).

stop_loss: Option<Order<ExchangeId, InstrumentNameExchange, UnindexedOrderState>>

Stop-loss order (opposite side, stop or stop-limit).

None when the exchange creates legs server-side (Alpaca). Some when the exchange returns legs immediately (IBKR).

Implementations

impl BracketOrderResult

pub fn with_all_legs( parent: Order<ExchangeId, InstrumentNameExchange, UnindexedOrderState>, take_profit: Order<ExchangeId, InstrumentNameExchange, UnindexedOrderState>, stop_loss: Order<ExchangeId, InstrumentNameExchange, UnindexedOrderState>, ) -> Self

Create a result with all three legs present.

Use for exchanges that return all orders immediately (e.g., IBKR).

pub fn parent_only( parent: Order<ExchangeId, InstrumentNameExchange, UnindexedOrderState>, ) -> Self

Create a result with only the parent order.

Use for exchanges that create child legs server-side (e.g., Alpaca).

pub fn has_all_legs(&self) -> bool

Returns true if all child legs are present.

pub fn is_failed(&self) -> bool

Returns true if the parent order placement failed.

Checking only the parent is sufficient because of the struct invariant: either all orders are active or all are inactive. A failed parent implies failed legs (or no legs returned, in the case of Alpaca).

Trait Implementations

impl Clone for BracketOrderResult

fn clone(&self) -> BracketOrderResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BracketOrderResult

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

Formats the value using the given formatter.