Struct fxoanda::MarketOrderTransaction

pub struct MarketOrderTransaction {

    pub long_position_closeout: Option<MarketOrderPositionCloseout>,
    pub short_position_closeout: Option<MarketOrderPositionCloseout>,
    pub time_in_force: Option<String>,
    pub request_id: Option<String>,
    pub id: Option<String>,
    pub position_fill: Option<String>,
    pub price_bound: Option<f32>,
    pub user_id: Option<i32>,
    pub instrument: Option<String>,
    pub units: Option<f32>,
    pub otype: Option<String>,
    pub account_id: Option<String>,
    pub stop_loss_on_fill: Option<StopLossDetails>,
    pub batch_id: Option<String>,
    pub delayed_trade_close: Option<MarketOrderDelayedTradeClose>,
    pub reason: Option<String>,
    pub trade_close: Option<MarketOrderTradeClose>,
    pub trailing_stop_loss_on_fill: Option<TrailingStopLossDetails>,
    pub client_extensions: Option<ClientExtensions>,
    pub take_profit_on_fill: Option<TakeProfitDetails>,
    pub trade_client_extensions: Option<ClientExtensions>,
    pub time: Option<DateTime<Utc>>,
    pub margin_closeout: Option<MarketOrderMarginCloseout>,
}

Fields

long_position_closeout: Option<MarketOrderPositionCloseout>

A MarketOrderPositionCloseout specifies the extensions to a Market Order when it has been created to closeout a specific Position.

short_position_closeout: Option<MarketOrderPositionCloseout>

A MarketOrderPositionCloseout specifies the extensions to a Market Order when it has been created to closeout a specific Position.

time_in_force: Option<String>

The time-in-force requested for the Market Order. Restricted to FOK or IOC for a MarketOrder.

request_id: Option<String>

The Request ID of the request which generated the transaction.

id: Option<String>

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

position_fill: Option<String>

Specification of how Positions in the Account are modified when the Order is filled.

price_bound: Option<f32>

The worst price that the client is willing to have the Market Order filled at. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

user_id: Option<i32>

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

instrument: Option<String>

The Market Order’s Instrument. format: A string containing the base currency and quote currency delimited by a “_”.

units: Option<f32>

The quantity requested to be filled by the Market Order. A posititive number of units results in a long Order, and a negative number of units results in a short Order. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

otype: Option<String>

The Type of the Transaction. Always set to “MARKET_ORDER” in a MarketOrderTransaction.

account_id: Option<String>

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

stop_loss_on_fill: Option<StopLossDetails>

StopLossDetails specifies the details of a Stop Loss Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Stop Loss, or when a Trade’s dependent Stop Loss Order is modified directly through the Trade.

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

delayed_trade_close: Option<MarketOrderDelayedTradeClose>

Details for the Market Order extensions specific to a Market Order placed with the intent of fully closing a specific open trade that should have already been closed but wasn’t due to halted market conditions

reason: Option<String>

The reason that the Market Order was created

trade_close: Option<MarketOrderTradeClose>

A MarketOrderTradeClose specifies the extensions to a Market Order that has been created specifically to close a Trade.

trailing_stop_loss_on_fill: Option<TrailingStopLossDetails>

TrailingStopLossDetails specifies the details of a Trailing Stop Loss Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Trailing Stop Loss, or when a Trade’s dependent Trailing Stop Loss Order is modified directly through the Trade.

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.

take_profit_on_fill: Option<TakeProfitDetails>

TakeProfitDetails specifies the details of a Take Profit Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Take Profit, or when a Trade’s dependent Take Profit Order is modified directly through the Trade.

trade_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).

margin_closeout: Option<MarketOrderMarginCloseout>

Details for the Market Order extensions specific to a Market Order placed that is part of a Market Order Margin Closeout in a client’s account

Implementations

impl MarketOrderTransaction

pub fn new() -> MarketOrderTransaction

pub fn with_long_position_closeout( self, x: MarketOrderPositionCloseout ) -> MarketOrderTransaction

A MarketOrderPositionCloseout specifies the extensions to a Market Order when it has been created to closeout a specific Position.

• param MarketOrderPositionCloseout
• return MarketOrderTransaction

pub fn with_short_position_closeout( self, x: MarketOrderPositionCloseout ) -> MarketOrderTransaction

A MarketOrderPositionCloseout specifies the extensions to a Market Order when it has been created to closeout a specific Position.

• param MarketOrderPositionCloseout
• return MarketOrderTransaction

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

The time-in-force requested for the Market Order. Restricted to FOK or IOC for a MarketOrder.

• param String
• return MarketOrderTransaction

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

The Request ID of the request which generated the transaction.

• param String
• return MarketOrderTransaction

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

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

• param String
• return MarketOrderTransaction

pub fn with_position_fill(self, x: String) -> MarketOrderTransaction

Specification of how Positions in the Account are modified when the Order is filled.

• param String
• return MarketOrderTransaction

pub fn with_price_bound(self, x: f32) -> MarketOrderTransaction

The worst price that the client is willing to have the Market Order filled at. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

• param f32
• return MarketOrderTransaction

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

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

• param i32
• return MarketOrderTransaction

pub fn with_instrument(self, x: String) -> MarketOrderTransaction

The Market Order’s Instrument. format: A string containing the base currency and quote currency delimited by a “_”.

• param String
• return MarketOrderTransaction

pub fn with_units(self, x: f32) -> MarketOrderTransaction

The quantity requested to be filled by the Market Order. A posititive number of units results in a long Order, and a negative number of units results in a short Order. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

• param f32
• return MarketOrderTransaction

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

The Type of the Transaction. Always set to “MARKET_ORDER” in a MarketOrderTransaction.

• param String
• return MarketOrderTransaction

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

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

• param String
• return MarketOrderTransaction

pub fn with_stop_loss_on_fill( self, x: StopLossDetails ) -> MarketOrderTransaction

StopLossDetails specifies the details of a Stop Loss Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Stop Loss, or when a Trade’s dependent Stop Loss Order is modified directly through the Trade.

• param StopLossDetails
• return MarketOrderTransaction

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

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 MarketOrderTransaction

pub fn with_delayed_trade_close( self, x: MarketOrderDelayedTradeClose ) -> MarketOrderTransaction

Details for the Market Order extensions specific to a Market Order placed with the intent of fully closing a specific open trade that should have already been closed but wasn’t due to halted market conditions

• param MarketOrderDelayedTradeClose
• return MarketOrderTransaction

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

The reason that the Market Order was created

• param String
• return MarketOrderTransaction

pub fn with_trade_close( self, x: MarketOrderTradeClose ) -> MarketOrderTransaction

A MarketOrderTradeClose specifies the extensions to a Market Order that has been created specifically to close a Trade.

• param MarketOrderTradeClose
• return MarketOrderTransaction

pub fn with_trailing_stop_loss_on_fill( self, x: TrailingStopLossDetails ) -> MarketOrderTransaction

TrailingStopLossDetails specifies the details of a Trailing Stop Loss Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Trailing Stop Loss, or when a Trade’s dependent Trailing Stop Loss Order is modified directly through the Trade.

• param TrailingStopLossDetails
• return MarketOrderTransaction

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

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 MarketOrderTransaction

pub fn with_take_profit_on_fill( self, x: TakeProfitDetails ) -> MarketOrderTransaction

TakeProfitDetails specifies the details of a Take Profit Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Take Profit, or when a Trade’s dependent Take Profit Order is modified directly through the Trade.

• param TakeProfitDetails
• return MarketOrderTransaction

pub fn with_trade_client_extensions( self, x: ClientExtensions ) -> MarketOrderTransaction

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 MarketOrderTransaction

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

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 MarketOrderTransaction

pub fn with_margin_closeout( self, x: MarketOrderMarginCloseout ) -> MarketOrderTransaction

Details for the Market Order extensions specific to a Market Order placed that is part of a Market Order Margin Closeout in a client’s account

• param MarketOrderMarginCloseout
• return MarketOrderTransaction

Trait Implementations

impl Debug for MarketOrderTransaction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MarketOrderTransaction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MarketOrderTransaction

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.