Struct Instrument 

pub struct Instrument {

    pub name: Option<InstrumentName>,
    pub type: Option<InstrumentType>,
    pub display_name: Option<String>,
    pub pip_location: Option<i64>,
    pub display_precision: Option<i64>,
    pub trade_units_precision: Option<i64>,
    pub minimum_trade_size: Option<Decimal>,
    pub maximum_trailing_stop_distance: Option<Decimal>,
    pub minimum_guaranteed_stop_loss_distance: Option<Decimal>,
    pub minimum_trailing_stop_distance: Option<Decimal>,
    pub maximum_position_size: Option<Decimal>,
    pub maximum_order_units: Option<Decimal>,
    pub margin_rate: Option<Decimal>,
    pub commission: Option<InstrumentCommission>,
    pub guaranteed_stop_loss_order_mode: Option<GuaranteedStopLossOrderModeForInstrument>,
    pub guaranteed_stop_loss_order_execution_premium: Option<Decimal>,
    pub guaranteed_stop_loss_order_level_restriction: Option<GuaranteedStopLossOrderLevelRestriction>,
    pub financing: Option<InstrumentFinancing>,
    pub tags: Option<Vec<Tag>>,
}

Full specification of an Instrument.

Fields

name: Option<InstrumentName>

The name of the Instrument

type: Option<InstrumentType>

The type of the Instrument

display_name: Option<String>

The display name of the Instrument

pip_location: Option<i64>

The location of the “pip” for this instrument. The decimal position of the pip in this Instrument’s price can be found at 10 ^ pipLocation (e.g. -4 pipLocation results in a decimal pip position of 10 ^ -4 = 0.0001).

display_precision: Option<i64>

The number of decimal places that should be used to display prices for this instrument. (e.g. a displayPrecision of 5 would result in a price of “1” being displayed as “1.00000”)

trade_units_precision: Option<i64>

The amount of decimal places that may be provided when specifying the number of units traded for this instrument.

minimum_trade_size: Option<Decimal>

The smallest number of units allowed to be traded for this instrument.

maximum_trailing_stop_distance: Option<Decimal>

The maximum trailing stop distance allowed for a trailing stop loss created for this instrument. Specified in price units.

minimum_guaranteed_stop_loss_distance: Option<Decimal>

The minimum distance allowed between the Trade’s fill price and the configured price for guaranteed Stop Loss Orders created for this instrument. Specified in price units.

minimum_trailing_stop_distance: Option<Decimal>

The minimum trailing stop distance allowed for a trailing stop loss created for this instrument. Specified in price units.

maximum_position_size: Option<Decimal>

The maximum position size allowed for this instrument. Specified in units.

maximum_order_units: Option<Decimal>

The maximum units allowed for an Order placed for this instrument. Specified in units.

margin_rate: Option<Decimal>

The margin rate for this instrument.

commission: Option<InstrumentCommission>

The commission structure for this instrument.

guaranteed_stop_loss_order_mode: Option<GuaranteedStopLossOrderModeForInstrument>

The current Guaranteed Stop Loss Order mode of the Account for this Instrument.

guaranteed_stop_loss_order_execution_premium: Option<Decimal>

The amount that is charged to the account if a guaranteed Stop Loss Order is triggered and filled. The value is in price units and is charged for each unit of the Trade. This field will only be present if the Account’s guaranteedStopLossOrderMode for this Instrument is not ‘DISABLED’.

guaranteed_stop_loss_order_level_restriction: Option<GuaranteedStopLossOrderLevelRestriction>

The guaranteed Stop Loss Order level restriction for this instrument. This field will only be present if the Account’s guaranteedStopLossOrderMode for this Instrument is not ‘DISABLED’.

financing: Option<InstrumentFinancing>

Financing data for this instrument.

tags: Option<Vec<Tag>>

The tags associated with this instrument.

Trait Implementations

impl Clone for Instrument

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instrument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Instrument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Instrument

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Instrument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Instrument