Struct InstrumentCache 

pub struct InstrumentCache { /* private fields */ }

Thread-safe instrument cache with multiple lookup indices.

Shared between HTTP client, WebSocket client, and execution client via Arc. Provides O(1) lookups by InstrumentId, market ticker, or clob_pair_id.

Implementations

impl InstrumentCache

pub fn new() -> Self

Creates a new empty instrument cache.

pub fn insert(&self, instrument: InstrumentAny, market: PerpetualMarket)

Inserts an instrument with its market data.

This populates the primary storage and all lookup indices.

pub fn insert_many(&self, items: Vec<(InstrumentAny, PerpetualMarket)>)

Bulk inserts instruments with their market data.

Marks the cache as initialized after insertion.

pub fn clear(&self)

Clears all cached data.

Useful for refreshing instruments from the API.

pub fn insert_instrument_only(&self, instrument: InstrumentAny)

Inserts an instrument without market data (InstrumentId lookup only).

Use this for caching instruments when market params are not available. Note: get_by_clob_id() and get_by_market() won’t work for instruments inserted this way - only get() by InstrumentId will work.

pub fn insert_instruments_only(&self, instruments: Vec<InstrumentAny>)

Bulk inserts instruments without market data.

Marks the cache as initialized after insertion.

pub fn get(&self, instrument_id: &InstrumentId) -> Option<InstrumentAny>

Gets an instrument by InstrumentId.

pub fn get_by_market(&self, ticker: &str) -> Option<InstrumentAny>

Gets an instrument by market ticker (e.g., “BTC-USD”).

This is the identifier used in public WebSocket channels.

pub fn get_by_clob_id(&self, clob_pair_id: u32) -> Option<InstrumentAny>

Gets an instrument by clob_pair_id (e.g., 0, 1, 2).

This is the identifier used in blockchain transactions and order messages.

pub fn get_id_by_clob_id(&self, clob_pair_id: u32) -> Option<InstrumentId>

Gets an InstrumentId by clob_pair_id.

Returns directly from index without cloning full instrument.

pub fn get_id_by_market(&self, ticker: &str) -> Option<InstrumentId>

Gets an InstrumentId by market ticker.

Returns directly from index without cloning full instrument.

pub fn get_market_params( &self, instrument_id: &InstrumentId, ) -> Option<PerpetualMarket>

Gets full market parameters by InstrumentId.

Returns the complete PerpetualMarket data including margin requirements, quantization parameters, and current oracle price.

pub fn get_order_market_params( &self, instrument_id: &InstrumentId, ) -> Option<OrderMarketParams>

Gets order market parameters for order building.

Returns the subset of market data needed for constructing orders (quantization, clob_pair_id, etc.).

pub fn update_oracle_price(&self, ticker: &str, oracle_price: Decimal)

Updates oracle price for a market.

Called when receiving price updates via WebSocket v4_markets channel.

pub fn is_initialized(&self) -> bool

Returns whether the cache has been initialized with instrument data.

pub fn len(&self) -> usize

Returns the number of cached instruments.

pub fn is_empty(&self) -> bool

Returns whether the cache is empty.

pub fn all_instruments(&self) -> Vec<InstrumentAny>

Returns all cached instruments.

Useful for WebSocket handler initialization and instrument replay.

pub fn all_instrument_ids(&self) -> Vec<InstrumentId>

Returns all InstrumentIds.

pub fn contains(&self, instrument_id: &InstrumentId) -> bool

Checks if an instrument exists by InstrumentId.

pub fn contains_clob_id(&self, clob_pair_id: u32) -> bool

Checks if an instrument exists by clob_pair_id.

pub fn contains_market(&self, ticker: &str) -> bool

Checks if an instrument exists by market ticker (e.g., “BTC-USD”).

pub fn to_instrument_id_map(&self) -> HashMap<InstrumentId, InstrumentAny>

Returns a HashMap of all instruments keyed by InstrumentId.

This is useful for parsing functions that expect HashMap<InstrumentId, InstrumentAny>. Note: Creates a snapshot copy, so frequent calls should be avoided.

pub fn to_oracle_prices_map(&self) -> HashMap<InstrumentId, Decimal>

Returns a HashMap of oracle prices keyed by InstrumentId.

This is useful for parsing functions like parse_account_state that need oracle prices. Note: Creates a snapshot copy, so frequent calls should be avoided.

pub fn log_missing_clob_pair_id(&self, clob_pair_id: u32)

Logs a warning about a missing instrument for a clob_pair_id, listing known mappings.

Trait Implementations

impl Debug for InstrumentCache

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

Formats the value using the given formatter.

impl Default for InstrumentCache

fn default() -> InstrumentCache

Returns the “default value” for a type.