Struct InstrumentSpec 

pub struct InstrumentSpec {
    pub asset_class: AssetClass,
    pub contract_value: f64,
    pub tick_size: f64,
    pub lot_size: f64,
    pub min_notional: f64,
}

Exchange/asset metadata for one instrument.

Used by the framework to round prices/quantities to the venue’s increments, enforce a minimum order notional, and apply class-aware rules. Adapters that expose no metadata get a permissive default (see ExchangeClient::instrument_spec), which preserves today’s behaviour.

Fields

asset_class: AssetClass

Broad asset class.

contract_value: f64

Base-asset units per one contract (e.g. 0.001 BTC for XBTUSDTM); 1.0 for spot. Subsumes the older ExchangeClient::contract_value.

tick_size: f64

Minimum price increment (tick). 0.0 ⇒ unknown / unconstrained.

lot_size: f64

Minimum quantity increment (lot), in contracts. 0.0 ⇒ unknown; futures are typically whole contracts (1.0).

min_notional: f64

Minimum order notional in quote currency. 0.0 ⇒ no minimum.

Implementations

impl InstrumentSpec

pub const fn spot_default() -> Self

A permissive spot default: 1:1 contract value, no tick/lot/min-notional constraints. Appropriate when an adapter exposes no metadata.

pub const fn from_contract_value(contract_value: f64) -> Self

A futures-contract spec from a known contract_value, with no other constraints. Backs the blanket ExchangeClient::instrument_spec default so an adapter that only overrides contract_value still gets a correct (if minimal) spec.

pub fn round_price(&self, price: f64) -> f64

Round a price to the nearest valid tick. No-op when tick_size <= 0.

pub fn round_qty_down(&self, qty: f64) -> f64

Round a quantity down to the nearest valid lot — down so a sized order never exceeds the intended risk. No-op when lot_size <= 0.

pub fn meets_min_notional(&self, notional: f64) -> bool

Does notional (quote currency) meet the minimum order notional? Always true when min_notional is 0.0.

Trait Implementations

impl Clone for InstrumentSpec

fn clone(&self) -> InstrumentSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for InstrumentSpec

impl Debug for InstrumentSpec

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

Formats the value using the given formatter.

impl Default for InstrumentSpec

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InstrumentSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InstrumentSpec

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for InstrumentSpec

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 InstrumentSpec