Struct fxoanda_definitions::FixedPriceOrder
source · pub struct FixedPriceOrder {Show 21 fields
pub filled_time: Option<DateTime<Utc>>,
pub trade_state: Option<String>,
pub trade_reduced_id: Option<String>,
pub filling_transaction_id: Option<String>,
pub cancelled_time: Option<DateTime<Utc>>,
pub price: Option<f32>,
pub stop_loss_on_fill: Option<StopLossDetails>,
pub trade_closed_i_ds: Option<Vec<String>>,
pub trade_opened_id: Option<String>,
pub create_time: Option<DateTime<Utc>>,
pub instrument: Option<String>,
pub state: Option<String>,
pub position_fill: Option<String>,
pub trade_client_extensions: Option<ClientExtensions>,
pub trailing_stop_loss_on_fill: Option<TrailingStopLossDetails>,
pub units: Option<f32>,
pub cancelling_transaction_id: Option<String>,
pub client_extensions: Option<ClientExtensions>,
pub otype: Option<String>,
pub id: Option<String>,
pub take_profit_on_fill: Option<TakeProfitDetails>,
}
Fields§
§filled_time: Option<DateTime<Utc>>
Date/time when the Order was filled (only provided when the Order’s state is FILLED) 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).
trade_state: Option<String>
The state that the trade resulting from the Fixed Price Order should be set to.
trade_reduced_id: Option<String>
Trade ID of Trade reduced when the Order was filled (only provided when the Order’s state is FILLED and a Trade was reduced as a result of the fill) 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.
filling_transaction_id: Option<String>
ID of the Transaction that filled this Order (only provided when the Order’s state is FILLED) format: String representation of the numerical OANDA-assigned TransactionID
cancelled_time: Option<DateTime<Utc>>
Date/time when the Order was cancelled (only provided when the state of the Order is CANCELLED) 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).
price: Option<f32>
The price specified for the Fixed Price Order. This price is the exact price that the Fixed Price Order will be filled at. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.
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.
trade_closed_i_ds: Option<Vec<String>>
Trade IDs of Trades closed when the Order was filled (only provided when the Order’s state is FILLED and one or more Trades were closed as a result of the fill)
trade_opened_id: Option<String>
Trade ID of Trade opened when the Order was filled (only provided when the Order’s state is FILLED and a Trade was opened as a result of the fill) 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.
create_time: Option<DateTime<Utc>>
The time when the Order 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).
instrument: Option<String>
The Fixed Price Order’s Instrument. format: A string containing the base currency and quote currency delimited by a “_”.
state: Option<String>
The current state of the Order.
position_fill: Option<String>
Specification of how Positions in the Account are modified when the Order is filled.
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 Fixed Price 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.
cancelling_transaction_id: Option<String>
ID of the Transaction that cancelled the Order (only provided when the Order’s state is CANCELLED) format: String representation of the numerical OANDA-assigned TransactionID
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. Always set to “FIXED_PRICE” for Fixed Price Orders.
id: Option<String>
The Order’s identifier, unique within the Order’s Account. 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.
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.
Implementations§
source§impl FixedPriceOrder
impl FixedPriceOrder
pub fn new() -> FixedPriceOrder
sourcepub fn with_filled_time(self, x: DateTime<Utc>) -> Self
pub fn with_filled_time(self, x: DateTime<Utc>) -> Self
Date/time when the Order was filled (only provided when the Order’s state is FILLED) 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 FixedPriceOrder
sourcepub fn with_trade_state(self, x: String) -> Self
pub fn with_trade_state(self, x: String) -> Self
The state that the trade resulting from the Fixed Price Order should be set to.
- param String
- return FixedPriceOrder
sourcepub fn with_trade_reduced_id(self, x: String) -> Self
pub fn with_trade_reduced_id(self, x: String) -> Self
Trade ID of Trade reduced when the Order was filled (only provided when the Order’s state is FILLED and a Trade was reduced as a result of the fill) 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 FixedPriceOrder
sourcepub fn with_filling_transaction_id(self, x: String) -> Self
pub fn with_filling_transaction_id(self, x: String) -> Self
ID of the Transaction that filled this Order (only provided when the Order’s state is FILLED) format: String representation of the numerical OANDA-assigned TransactionID
- param String
- return FixedPriceOrder
sourcepub fn with_cancelled_time(self, x: DateTime<Utc>) -> Self
pub fn with_cancelled_time(self, x: DateTime<Utc>) -> Self
Date/time when the Order was cancelled (only provided when the state of the Order is CANCELLED) 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 FixedPriceOrder
sourcepub fn with_price(self, x: f32) -> Self
pub fn with_price(self, x: f32) -> Self
The price specified for the Fixed Price Order. This price is the exact price that the Fixed Price Order will be filled at. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.
- param f32
- return FixedPriceOrder
sourcepub fn with_stop_loss_on_fill(self, x: StopLossDetails) -> Self
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 FixedPriceOrder
sourcepub fn with_trade_closed_i_ds(self, x: Vec<String>) -> Self
pub fn with_trade_closed_i_ds(self, x: Vec<String>) -> Self
Trade IDs of Trades closed when the Order was filled (only provided when the Order’s state is FILLED and one or more Trades were closed as a result of the fill)
- param Vec
- return FixedPriceOrder
sourcepub fn with_trade_opened_id(self, x: String) -> Self
pub fn with_trade_opened_id(self, x: String) -> Self
Trade ID of Trade opened when the Order was filled (only provided when the Order’s state is FILLED and a Trade was opened as a result of the fill) 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 FixedPriceOrder
sourcepub fn with_create_time(self, x: DateTime<Utc>) -> Self
pub fn with_create_time(self, x: DateTime<Utc>) -> Self
The time when the Order 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 FixedPriceOrder
sourcepub fn with_instrument(self, x: String) -> Self
pub fn with_instrument(self, x: String) -> Self
The Fixed Price Order’s Instrument. format: A string containing the base currency and quote currency delimited by a “_”.
- param String
- return FixedPriceOrder
sourcepub fn with_state(self, x: String) -> Self
pub fn with_state(self, x: String) -> Self
The current state of the Order.
- param String
- return FixedPriceOrder
sourcepub fn with_position_fill(self, x: String) -> Self
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 FixedPriceOrder
sourcepub fn with_trade_client_extensions(self, x: ClientExtensions) -> Self
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 FixedPriceOrder
sourcepub fn with_trailing_stop_loss_on_fill(self, x: TrailingStopLossDetails) -> Self
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 FixedPriceOrder
sourcepub fn with_units(self, x: f32) -> Self
pub fn with_units(self, x: f32) -> Self
The quantity requested to be filled by the Fixed Price 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 FixedPriceOrder
sourcepub fn with_cancelling_transaction_id(self, x: String) -> Self
pub fn with_cancelling_transaction_id(self, x: String) -> Self
ID of the Transaction that cancelled the Order (only provided when the Order’s state is CANCELLED) format: String representation of the numerical OANDA-assigned TransactionID
- param String
- return FixedPriceOrder
sourcepub fn with_client_extensions(self, x: ClientExtensions) -> Self
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 FixedPriceOrder
sourcepub fn with_otype(self, x: String) -> Self
pub fn with_otype(self, x: String) -> Self
The type of the Order. Always set to “FIXED_PRICE” for Fixed Price Orders.
- param String
- return FixedPriceOrder
sourcepub fn with_id(self, x: String) -> Self
pub fn with_id(self, x: String) -> Self
The Order’s identifier, unique within the Order’s Account. 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 FixedPriceOrder
sourcepub fn with_take_profit_on_fill(self, x: TakeProfitDetails) -> Self
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 FixedPriceOrder