Struct StopLossOrderRequest 

pub struct StopLossOrderRequest {
    pub trade_id: TradeId,
    pub client_trade_id: Option<ClientId>,
    pub price: Option<PriceValue>,
    pub distance: Option<DecimalNumber>,
    pub time_in_force: Option<StopLossOrderTimeInForce>,
    pub gtd_time: Option<DateTime>,
    pub trigger_condition: Option<OrderTriggerCondition>,
    pub guaranteed: Option<bool>,
    pub client_extensions: Option<ClientExtensions>,
}

Specification of a stop-loss order attached to an existing trade. Exactly one of price or distance must be set (see StopLossOrderRequest::at_price and StopLossOrderRequest::at_distance).

Fields

trade_id: TradeId

The ID of the trade to close when the order is filled.

client_trade_id: Option<ClientId>

The client ID of the trade to be closed when the order is filled.

price: Option<PriceValue>

The price threshold: the associated trade will be closed by a market price that is equal to or worse than this threshold.

distance: Option<DecimalNumber>

The distance (in price units) from the trade’s open price to use as the stop-loss price instead of an absolute price.

time_in_force: Option<StopLossOrderTimeInForce>

The time-in-force for the order (default GTC).

gtd_time: Option<DateTime>

The date/time when the order is cancelled if time_in_force is GTD.

trigger_condition: Option<OrderTriggerCondition>

Which price component is used to trigger the order (default DEFAULT).

guaranteed: Option<bool>

Deprecated: whether the order is guaranteed (only allowed when the account’s guaranteedStopLossOrderMode permits it).

client_extensions: Option<ClientExtensions>

The client extensions to add to the order.

Implementations

impl StopLossOrderRequest

pub fn at_price( trade_id: impl Into<TradeId>, price: impl Into<PriceValue>, ) -> Self

A stop-loss order closing trade_id at the absolute price threshold price.

pub fn at_distance( trade_id: impl Into<TradeId>, distance: impl Into<DecimalNumber>, ) -> Self

A stop-loss order closing trade_id at distance price units from the trade’s open price.

pub fn client_trade_id(self, value: impl Into<ClientId>) -> Self

Targets the trade by its client-provided ID instead.

pub fn time_in_force(self, value: impl Into<StopLossOrderTimeInForce>) -> Self

Sets the time-in-force (default GTC).

pub fn gtd_time(self, value: impl Into<DateTime>) -> Self

Sets the cancellation time used with GTD.

pub fn trigger_condition(self, value: impl Into<OrderTriggerCondition>) -> Self

Sets the price component used for triggering.

pub fn client_extensions(self, value: impl Into<ClientExtensions>) -> Self

Attaches client extensions to the order.

Trait Implementations

impl Clone for StopLossOrderRequest

fn clone(&self) -> StopLossOrderRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StopLossOrderRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StopLossOrderRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StopLossOrderRequest> for OrderRequest

fn from(request: StopLossOrderRequest) -> Self

Converts to this type from the input type.

impl PartialEq for StopLossOrderRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StopLossOrderRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StopLossOrderRequest