Struct fxoanda_definitions::StopLossDetails
source · pub struct StopLossDetails {
pub distance: Option<f32>,
pub client_extensions: Option<ClientExtensions>,
pub price: Option<f32>,
pub guaranteed: Option<bool>,
pub time_in_force: Option<String>,
pub gtd_time: Option<DateTime<Utc>>,
}
Fields§
§distance: Option<f32>
Specifies the distance (in price units) from the Trade’s open price to use as the Stop Loss Order price. Only one of the distance and price fields may be specified. 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.
price: Option<f32>
The price that the Stop Loss Order will be triggered at. Only one of the price and distance fields may be specified. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.
guaranteed: Option<bool>
Flag indicating that the price for 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.
time_in_force: Option<String>
The time in force for the created Stop Loss Order. This may only be GTC, GTD or GFD.
gtd_time: Option<DateTime<Utc>>
The date when the Stop Loss Order will be cancelled on if 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).
Implementations§
source§impl StopLossDetails
impl StopLossDetails
pub fn new() -> StopLossDetails
sourcepub fn with_distance(self, x: f32) -> Self
pub fn with_distance(self, x: f32) -> Self
Specifies the distance (in price units) from the Trade’s open price to use as the Stop Loss Order price. Only one of the distance and price fields may be specified. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.
- param f32
- return StopLossDetails
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 StopLossDetails
sourcepub fn with_price(self, x: f32) -> Self
pub fn with_price(self, x: f32) -> Self
The price that the Stop Loss Order will be triggered at. Only one of the price and distance fields may be specified. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.
- param f32
- return StopLossDetails
sourcepub fn with_guaranteed(self, x: bool) -> Self
pub fn with_guaranteed(self, x: bool) -> Self
Flag indicating that the price for 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 StopLossDetails
sourcepub fn with_time_in_force(self, x: String) -> Self
pub fn with_time_in_force(self, x: String) -> Self
The time in force for the created Stop Loss Order. This may only be GTC, GTD or GFD.
- param String
- return StopLossDetails
sourcepub fn with_gtd_time(self, x: DateTime<Utc>) -> Self
pub fn with_gtd_time(self, x: DateTime<Utc>) -> Self
The date when the Stop Loss Order will be cancelled on if 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 StopLossDetails