Struct fxoanda_definitions::MarketOrderRequest

pub struct MarketOrderRequest {
    pub stop_loss_on_fill: Option<StopLossDetails>,
    pub position_fill: Option<String>,
    pub price_bound: Option<f32>,
    pub take_profit_on_fill: Option<TakeProfitDetails>,
    pub time_in_force: Option<String>,
    pub instrument: Option<String>,
    pub trade_client_extensions: Option<ClientExtensions>,
    pub trailing_stop_loss_on_fill: Option<TrailingStopLossDetails>,
    pub units: Option<f32>,
    pub client_extensions: Option<ClientExtensions>,
    pub otype: Option<String>,
}

Fields

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.

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.

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.

time_in_force: Option<String>

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

instrument: Option<String>

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

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.

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.

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.

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.

otype: Option<String>

The type of the Order to Create. Must be set to "MARKET" when creating a Market Order.

Methods

impl MarketOrderRequest

pub fn new() -> MarketOrderRequest

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

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 MarketOrderRequest

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

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

• param String
• return MarketOrderRequest

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

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 MarketOrderRequest

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

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 MarketOrderRequest

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

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

• param String
• return MarketOrderRequest

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

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

• param String
• return MarketOrderRequest

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

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 MarketOrderRequest

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

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 MarketOrderRequest

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

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 MarketOrderRequest

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

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 MarketOrderRequest

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

The type of the Order to Create. Must be set to "MARKET" when creating a Market Order.

• param String
• return MarketOrderRequest

Trait Implementations

impl Debug for MarketOrderRequest

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

Formats the value using the given formatter.

impl Serialize for MarketOrderRequest

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for MarketOrderRequest

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

Deserialize this value from the given Serde deserializer.