Struct PositionBook 

#[non_exhaustive]
pub struct PositionBook {
    pub instrument: Option<InstrumentName>,
    pub time: Option<DateTime>,
    pub price: Option<PriceValue>,
    pub bucket_width: Option<PriceValue>,
    pub buckets: Vec<PositionBookBucket>,
    pub unix_time: Option<DateTime>,
}

The representation of an instrument’s position book at a point in time

Fields (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.

instrument: Option<InstrumentName>

The position book’s instrument

time: Option<DateTime>

The time when the position book snapshot was created

price: Option<PriceValue>

The price (midpoint) for the position book’s instrument at the time of the position book snapshot

bucket_width: Option<PriceValue>

The price width for each bucket. Each bucket covers the price range from the bucket’s price to the bucket’s price + bucketWidth.

buckets: Vec<PositionBookBucket>

The partitioned position book, divided into buckets using a default bucket width. These buckets are only provided for price ranges which actually contain order or position data.

unix_time: Option<DateTime>

The book’s creation time as a Unix timestamp (seconds), string-encoded. This field is returned by the live v20 API but is not present in OANDA’s official documentation.

Trait Implementations

impl Clone for PositionBook

fn clone(&self) -> PositionBook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PositionBook

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PositionBook

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PositionBook

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PositionBook

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 PositionBook