Struct Instrument 

#[non_exhaustive]
pub struct Instrument {
    pub key: MarketKey,
    pub name: String,
    pub base_asset: Option<String>,
    pub quote_asset: Option<String>,
    pub size_unit: SizeUnit,
    pub tick_size: Option<Decimal>,
    pub min_size: Option<Decimal>,
    pub size_increment: Option<Decimal>,
    pub min_notional: Option<Decimal>,
    pub tradable: Option<bool>,
    pub extensions: Extensions,
}

An instrument a venue lists, and the one record that carries its trading rules: tick size, minimum size and SizeUnit.

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.

key: MarketKey

The instrument’s key.

name: String

A name for people: the venue’s symbol, or for an outcome of an event contract, its market and outcome.

base_asset: Option<String>

The asset the instrument’s sizes are written in, when the venue names one.

quote_asset: Option<String>

The currency its prices are quoted in, when the venue names one.

size_unit: SizeUnit

What its sizes count.

tick_size: Option<Decimal>

The smallest price step, when the venue publishes a fixed one.

min_size: Option<Decimal>

The smallest order size, in native quantity.

size_increment: Option<Decimal>

The smallest size step, in native quantity.

min_notional: Option<Decimal>

The smallest order value, in the quote currency.

tradable: Option<bool>

Whether the venue now takes orders on it that open or add to a position. A close-only instrument is not tradable.

extensions: Extensions

The venue’s own facts.

Implementations

impl Instrument

pub fn new(key: MarketKey, name: impl Into<String>, size_unit: SizeUnit) -> Self

An instrument with its key, name and size unit, and nothing else known.

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 PartialEq for Instrument

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Instrument