Struct fxoanda::StopLossOrderRejectTransaction

pub struct StopLossOrderRejectTransaction {

    pub distance: Option<f32>,
    pub time_in_force: Option<String>,
    pub trigger_condition: Option<String>,
    pub intended_replaces_order_id: Option<String>,
    pub trade_id: Option<String>,
    pub guaranteed: Option<bool>,
    pub price: Option<f32>,
    pub client_trade_id: Option<String>,
    pub user_id: Option<i32>,
    pub batch_id: Option<String>,
    pub reject_reason: Option<String>,
    pub reason: Option<String>,
    pub request_id: Option<String>,
    pub client_extensions: Option<ClientExtensions>,
    pub time: Option<DateTime<Utc>>,
    pub order_fill_transaction_id: Option<String>,
    pub gtd_time: Option<DateTime<Utc>>,
    pub otype: Option<String>,
    pub id: Option<String>,
    pub account_id: Option<String>,
}

Fields

distance: Option<f32>

Specifies the distance (in price units) from the Account’s current price to use as the Stop Loss Order price. If the Trade is short the Instrument’s bid price is used, and for long Trades the ask is used. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

time_in_force: Option<String>

The time-in-force requested for the StopLoss Order. Restricted to “GTC”, “GFD” and “GTD” for StopLoss Orders.

trigger_condition: Option<String>

Specification of which price component should be used when determining if an Order should be triggered and filled. This allows Orders to be triggered based on the bid, ask, mid, default (ask for buy, bid for sell) or inverse (ask for sell, bid for buy) price depending on the desired behaviour. Orders are always filled using their default price component. This feature is only provided through the REST API. Clients who choose to specify a non-default trigger condition will not see it reflected in any of OANDA’s proprietary or partner trading platforms, their transaction history or their account statements. OANDA platforms always assume that an Order’s trigger condition is set to the default value when indicating the distance from an Order’s trigger price, and will always provide the default trigger condition when creating or modifying an Order. A special restriction applies when creating a guaranteed Stop Loss Order. In this case the TriggerCondition value must either be “DEFAULT”, or the “natural” trigger side “DEFAULT” results in. So for a Stop Loss Order for a long trade valid values are “DEFAULT” and “BID”, and for short trades “DEFAULT” and “ASK” are valid.

intended_replaces_order_id: Option<String>

The ID of the Order that this Order was intended to replace (only provided if this Order was intended to replace an existing Order). format: The string representation of the OANDA-assigned OrderID. OANDA- assigned OrderIDs are positive integers, and are derived from the TransactionID of the Transaction that created the Order.

trade_id: Option<String>

The ID of the Trade to close when the price threshold is breached. format: The string representation of the OANDA-assigned TradeID. OANDA- assigned TradeIDs are positive integers, and are derived from the TransactionID of the Transaction that opened the Trade.

guaranteed: Option<bool>

Flag indicating that the Stop Loss Order is guaranteed. The default value depends on the GuaranteedStopLossOrderMode of the account, if it is REQUIRED, the default will be true, for DISABLED or ENABLED the default is false.

price: Option<f32>

The price threshold specified for the Stop Loss Order. If the guaranteed flag is false, the associated Trade will be closed by a market price that is equal to or worse than this threshold. If the flag is true the associated Trade will be closed at this price. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

client_trade_id: Option<String>

The client ID of the Trade to be closed when the price threshold is breached.

user_id: Option<i32>

The ID of the user that initiated the creation of the Transaction.

batch_id: Option<String>

The ID of the “batch” that the Transaction belongs to. Transactions in the same batch are applied to the Account simultaneously. format: String representation of the numerical OANDA-assigned TransactionID

reject_reason: Option<String>

The reason that the Reject Transaction was created

reason: Option<String>

The reason that the Stop Loss Order was initiated

request_id: Option<String>

The Request ID of the request which generated the transaction.

client_extensions: Option<ClientExtensions>

A ClientExtensions object allows a client to attach a clientID, tag and comment to Orders and Trades in their Account. Do not set, modify, or delete this field if your account is associated with MT4.

time: Option<DateTime<Utc>>

The date/time when the Transaction was created. format: The RFC 3339 representation is a string conforming to https://tools.ietf.org/rfc/rfc3339.txt. The Unix representation is a string representing the number of seconds since the Unix Epoch (January 1st, 1970 at UTC). The value is a fractional number, where the fractional part represents a fraction of a second (up to nine decimal places).

order_fill_transaction_id: Option<String>

The ID of the OrderFill Transaction that caused this Order to be created (only provided if this Order was created automatically when another Order was filled). format: String representation of the numerical OANDA-assigned TransactionID

gtd_time: Option<DateTime<Utc>>

The date/time when the StopLoss Order will be cancelled if its timeInForce is “GTD”. format: The RFC 3339 representation is a string conforming to https://tools.ietf.org/rfc/rfc3339.txt. The Unix representation is a string representing the number of seconds since the Unix Epoch (January 1st, 1970 at UTC). The value is a fractional number, where the fractional part represents a fraction of a second (up to nine decimal places).

otype: Option<String>

The Type of the Transaction. Always set to “STOP_LOSS_ORDER_REJECT” in a StopLossOrderRejectTransaction.

id: Option<String>

The Transaction’s Identifier. format: String representation of the numerical OANDA-assigned TransactionID

account_id: Option<String>

The ID of the Account the Transaction was created for. format: “-”-delimited string with format “{siteID}-{divisionID}-{userID}-{accountNumber}”

Implementations

impl StopLossOrderRejectTransaction

pub fn new() -> StopLossOrderRejectTransaction

pub fn with_distance(self, x: f32) -> StopLossOrderRejectTransaction

Specifies the distance (in price units) from the Account’s current price to use as the Stop Loss Order price. If the Trade is short the Instrument’s bid price is used, and for long Trades the ask is used. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

• param f32
• return StopLossOrderRejectTransaction

pub fn with_time_in_force(self, x: String) -> StopLossOrderRejectTransaction

The time-in-force requested for the StopLoss Order. Restricted to “GTC”, “GFD” and “GTD” for StopLoss Orders.

• param String
• return StopLossOrderRejectTransaction

pub fn with_trigger_condition(self, x: String) -> StopLossOrderRejectTransaction

Specification of which price component should be used when determining if an Order should be triggered and filled. This allows Orders to be triggered based on the bid, ask, mid, default (ask for buy, bid for sell) or inverse (ask for sell, bid for buy) price depending on the desired behaviour. Orders are always filled using their default price component. This feature is only provided through the REST API. Clients who choose to specify a non-default trigger condition will not see it reflected in any of OANDA’s proprietary or partner trading platforms, their transaction history or their account statements. OANDA platforms always assume that an Order’s trigger condition is set to the default value when indicating the distance from an Order’s trigger price, and will always provide the default trigger condition when creating or modifying an Order. A special restriction applies when creating a guaranteed Stop Loss Order. In this case the TriggerCondition value must either be “DEFAULT”, or the “natural” trigger side “DEFAULT” results in. So for a Stop Loss Order for a long trade valid values are “DEFAULT” and “BID”, and for short trades “DEFAULT” and “ASK” are valid.

• param String
• return StopLossOrderRejectTransaction

pub fn with_intended_replaces_order_id( self, x: String ) -> StopLossOrderRejectTransaction

The ID of the Order that this Order was intended to replace (only provided if this Order was intended to replace an existing Order). format: The string representation of the OANDA-assigned OrderID. OANDA- assigned OrderIDs are positive integers, and are derived from the TransactionID of the Transaction that created the Order.

• param String
• return StopLossOrderRejectTransaction

pub fn with_trade_id(self, x: String) -> StopLossOrderRejectTransaction

The ID of the Trade to close when the price threshold is breached. format: The string representation of the OANDA-assigned TradeID. OANDA- assigned TradeIDs are positive integers, and are derived from the TransactionID of the Transaction that opened the Trade.

• param String
• return StopLossOrderRejectTransaction

pub fn with_guaranteed(self, x: bool) -> StopLossOrderRejectTransaction

Flag indicating that the Stop Loss Order is guaranteed. The default value depends on the GuaranteedStopLossOrderMode of the account, if it is REQUIRED, the default will be true, for DISABLED or ENABLED the default is false.

• param bool
• return StopLossOrderRejectTransaction

pub fn with_price(self, x: f32) -> StopLossOrderRejectTransaction

The price threshold specified for the Stop Loss Order. If the guaranteed flag is false, the associated Trade will be closed by a market price that is equal to or worse than this threshold. If the flag is true the associated Trade will be closed at this price. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

• param f32
• return StopLossOrderRejectTransaction

pub fn with_client_trade_id(self, x: String) -> StopLossOrderRejectTransaction

The client ID of the Trade to be closed when the price threshold is breached.

• param String
• return StopLossOrderRejectTransaction

pub fn with_user_id(self, x: i32) -> StopLossOrderRejectTransaction

The ID of the user that initiated the creation of the Transaction.

• param i32
• return StopLossOrderRejectTransaction

pub fn with_batch_id(self, x: String) -> StopLossOrderRejectTransaction

The ID of the “batch” that the Transaction belongs to. Transactions in the same batch are applied to the Account simultaneously. format: String representation of the numerical OANDA-assigned TransactionID

• param String
• return StopLossOrderRejectTransaction

pub fn with_reject_reason(self, x: String) -> StopLossOrderRejectTransaction

The reason that the Reject Transaction was created

• param String
• return StopLossOrderRejectTransaction

pub fn with_reason(self, x: String) -> StopLossOrderRejectTransaction

The reason that the Stop Loss Order was initiated

• param String
• return StopLossOrderRejectTransaction

pub fn with_request_id(self, x: String) -> StopLossOrderRejectTransaction

The Request ID of the request which generated the transaction.

• param String
• return StopLossOrderRejectTransaction

pub fn with_client_extensions( self, x: ClientExtensions ) -> StopLossOrderRejectTransaction

A ClientExtensions object allows a client to attach a clientID, tag and comment to Orders and Trades in their Account. Do not set, modify, or delete this field if your account is associated with MT4.

• param ClientExtensions
• return StopLossOrderRejectTransaction

pub fn with_time(self, x: DateTime<Utc>) -> StopLossOrderRejectTransaction

The date/time when the Transaction was created. format: The RFC 3339 representation is a string conforming to https://tools.ietf.org/rfc/rfc3339.txt. The Unix representation is a string representing the number of seconds since the Unix Epoch (January 1st, 1970 at UTC). The value is a fractional number, where the fractional part represents a fraction of a second (up to nine decimal places).

• param DateTime
• return StopLossOrderRejectTransaction

pub fn with_order_fill_transaction_id( self, x: String ) -> StopLossOrderRejectTransaction

The ID of the OrderFill Transaction that caused this Order to be created (only provided if this Order was created automatically when another Order was filled). format: String representation of the numerical OANDA-assigned TransactionID

• param String
• return StopLossOrderRejectTransaction

pub fn with_gtd_time(self, x: DateTime<Utc>) -> StopLossOrderRejectTransaction

The date/time when the StopLoss Order will be cancelled if its timeInForce is “GTD”. format: The RFC 3339 representation is a string conforming to https://tools.ietf.org/rfc/rfc3339.txt. The Unix representation is a string representing the number of seconds since the Unix Epoch (January 1st, 1970 at UTC). The value is a fractional number, where the fractional part represents a fraction of a second (up to nine decimal places).

• param DateTime
• return StopLossOrderRejectTransaction

pub fn with_otype(self, x: String) -> StopLossOrderRejectTransaction

The Type of the Transaction. Always set to “STOP_LOSS_ORDER_REJECT” in a StopLossOrderRejectTransaction.

• param String
• return StopLossOrderRejectTransaction

pub fn with_id(self, x: String) -> StopLossOrderRejectTransaction

The Transaction’s Identifier. format: String representation of the numerical OANDA-assigned TransactionID

• param String
• return StopLossOrderRejectTransaction

pub fn with_account_id(self, x: String) -> StopLossOrderRejectTransaction

The ID of the Account the Transaction was created for. format: “-”-delimited string with format “{siteID}-{divisionID}-{userID}-{accountNumber}”

• param String
• return StopLossOrderRejectTransaction

Trait Implementations

impl Debug for StopLossOrderRejectTransaction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StopLossOrderRejectTransaction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StopLossOrderRejectTransaction

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.