Skip to main content

TrailingStopLossOrder

Struct TrailingStopLossOrder 

Source
#[non_exhaustive]
pub struct TrailingStopLossOrder {
Show 20 fields pub id: Option<OrderId>, pub create_time: Option<DateTime>, pub state: Option<OrderState>, pub client_extensions: Option<ClientExtensions>, pub trade_id: Option<TradeId>, pub client_trade_id: Option<String>, pub distance: Option<DecimalNumber>, pub time_in_force: Option<TrailingStopLossOrderTimeInForce>, pub gtd_time: Option<DateTime>, pub trigger_condition: Option<OrderTriggerCondition>, pub trailing_stop_value: Option<PriceValue>, pub filling_transaction_id: Option<TransactionId>, pub filled_time: Option<DateTime>, pub trade_opened_id: Option<TradeId>, pub trade_reduced_id: Option<TradeId>, pub trade_closed_ids: Vec<TradeId>, pub cancelling_transaction_id: Option<TransactionId>, pub cancelled_time: Option<DateTime>, pub replaces_order_id: Option<OrderId>, pub replaced_by_order_id: Option<OrderId>,
}
Expand description

A TrailingStopLossOrder is an order that is linked to an open Trade and created with a price distance. The price distance is used to calculate a trailing stop value for the order that is in the losing direction from the market price at the time of the order’s creation. The trailing stop value will follow the market price as it moves in the winning direction, and the order will filled (closing the Trade) by the first price that is equal to or worse than the trailing stop value. A TrailingStopLossOrder cannot be used to open a new Position.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§id: Option<OrderId>

The Order’s identifier, unique within the Order’s Account.

§create_time: Option<DateTime>

The time when the Order was created.

§state: Option<OrderState>

The state field.

§client_extensions: Option<ClientExtensions>

The clientExtensions field.

§trade_id: Option<TradeId>

The ID of the Trade to close when the price threshold is breached.

§client_trade_id: Option<String>

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

§distance: Option<DecimalNumber>

The price distance (in price units) specified for the TrailingStopLoss Order.

§time_in_force: Option<TrailingStopLossOrderTimeInForce>

The timeInForce field.

§gtd_time: Option<DateTime>

The date/time when the StopLoss Order will be cancelled if its timeInForce is “GTD”.

§trigger_condition: Option<OrderTriggerCondition>

The triggerCondition field.

§trailing_stop_value: Option<PriceValue>

The trigger price for the Trailing Stop Loss Order. The trailing stop value will trail (follow) the market price by the TSL order’s configured “distance” as the market price moves in the winning direction. If the market price moves to a level that is equal to or worse than the trailing stop value, the order will be filled and the Trade will be closed.

§filling_transaction_id: Option<TransactionId>

ID of the Transaction that filled this Order (only provided when the Order’s state is FILLED)

§filled_time: Option<DateTime>

Date/time when the Order was filled (only provided when the Order’s state is FILLED)

§trade_opened_id: Option<TradeId>

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)

§trade_reduced_id: Option<TradeId>

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)

§trade_closed_ids: Vec<TradeId>

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)

§cancelling_transaction_id: Option<TransactionId>

ID of the Transaction that cancelled the Order (only provided when the Order’s state is CANCELLED)

§cancelled_time: Option<DateTime>

Date/time when the Order was cancelled (only provided when the state of the Order is CANCELLED)

§replaces_order_id: Option<OrderId>

The ID of the Order that was replaced by this Order (only provided if this Order was created as part of a cancel/replace).

§replaced_by_order_id: Option<OrderId>

The ID of the Order that replaced this Order (only provided if this Order was cancelled as part of a cancel/replace).

Trait Implementations§

Source§

impl Clone for TrailingStopLossOrder

Source§

fn clone(&self) -> TrailingStopLossOrder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TrailingStopLossOrder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for TrailingStopLossOrder

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for TrailingStopLossOrder

Source§

fn eq(&self, other: &TrailingStopLossOrder) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for TrailingStopLossOrder

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for TrailingStopLossOrder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more