Struct fxoanda_definitions::ClientPrice

pub struct ClientPrice {
    pub status: Option<String>,
    pub quote_home_conversion_factors: Option<QuoteHomeConversionFactors>,
    pub asks: Option<Vec<PriceBucket>>,
    pub units_available: Option<UnitsAvailable>,
    pub closeout_bid: Option<f32>,
    pub bids: Option<Vec<PriceBucket>>,
    pub instrument: Option<String>,
    pub time: Option<DateTime<Utc>>,
    pub closeout_ask: Option<f32>,
    pub otype: Option<String>,
    pub tradeable: Option<bool>,
}

Fields

status: Option<String>

The status of the Price.

quote_home_conversion_factors: Option<QuoteHomeConversionFactors>

QuoteHomeConversionFactors represents the factors that can be used used to convert quantities of a Price’s Instrument’s quote currency into the Account’s home currency.

asks: Option<Vec<PriceBucket>>

The list of prices and liquidity available on the Instrument’s ask side. It is possible for this list to be empty if there is no ask liquidity currently available for the Instrument in the Account.

units_available: Option<UnitsAvailable>

Representation of how many units of an Instrument are available to be traded by an Order depending on its postionFill option.

closeout_bid: Option<f32>

The closeout bid Price. This Price is used when a bid is required to closeout a Position (margin closeout or manual) yet there is no bid liquidity. The closeout bid is never used to open a new position. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

bids: Option<Vec<PriceBucket>>

The list of prices and liquidity available on the Instrument’s bid side. It is possible for this list to be empty if there is no bid liquidity currently available for the Instrument in the Account.

instrument: Option<String>

The Price’s Instrument. format: A string containing the base currency and quote currency delimited by a “_”.

time: Option<DateTime<Utc>>

The date/time when the Price 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).

closeout_ask: Option<f32>

The closeout ask Price. This Price is used when a ask is required to closeout a Position (margin closeout or manual) yet there is no ask liquidity. The closeout ask is never used to open a new position. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

otype: Option<String>

The string “PRICE”. Used to identify the a Price object when found in a stream.

tradeable: Option<bool>

Flag indicating if the Price is tradeable or not

Implementations

impl ClientPrice

pub fn new() -> ClientPrice

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

The status of the Price.

• param String
• return ClientPrice

pub fn with_quote_home_conversion_factors( self, x: QuoteHomeConversionFactors ) -> Self

QuoteHomeConversionFactors represents the factors that can be used used to convert quantities of a Price’s Instrument’s quote currency into the Account’s home currency.

• param QuoteHomeConversionFactors
• return ClientPrice

pub fn with_asks(self, x: Vec<PriceBucket>) -> Self

The list of prices and liquidity available on the Instrument’s ask side. It is possible for this list to be empty if there is no ask liquidity currently available for the Instrument in the Account.

• param Vec
• return ClientPrice

pub fn with_units_available(self, x: UnitsAvailable) -> Self

Representation of how many units of an Instrument are available to be traded by an Order depending on its postionFill option.

• param UnitsAvailable
• return ClientPrice

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

The closeout bid Price. This Price is used when a bid is required to closeout a Position (margin closeout or manual) yet there is no bid liquidity. The closeout bid is never used to open a new position. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

• param f32
• return ClientPrice

pub fn with_bids(self, x: Vec<PriceBucket>) -> Self

The list of prices and liquidity available on the Instrument’s bid side. It is possible for this list to be empty if there is no bid liquidity currently available for the Instrument in the Account.

• param Vec
• return ClientPrice

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

The Price’s Instrument. format: A string containing the base currency and quote currency delimited by a “_”.

• param String
• return ClientPrice

pub fn with_time(self, x: DateTime<Utc>) -> Self

The date/time when the Price 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 ClientPrice

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

The closeout ask Price. This Price is used when a ask is required to closeout a Position (margin closeout or manual) yet there is no ask liquidity. The closeout ask is never used to open a new position. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

• param f32
• return ClientPrice

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

The string “PRICE”. Used to identify the a Price object when found in a stream.

• param String
• return ClientPrice

pub fn with_tradeable(self, x: bool) -> Self

Flag indicating if the Price is tradeable or not

• param bool
• return ClientPrice

Trait Implementations

impl Debug for ClientPrice

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientPrice

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ClientPrice

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

where __S: Serializer,

Serialize this value into the given Serde serializer.