Struct InstrumentId 

pub struct InstrumentId(/* private fields */);

Canonical stable instrument key.

Format: "spot:BTC-USD", "perp-linear:ETH-USDT", "perp-inverse:BTC-USD", "future:BTC-USD:2025-06-27".

Implementations

impl InstrumentId

pub fn from_kind(kind: &InstrumentKind) -> Result<Self, InvalidInstrumentId>

Derive the canonical ID from an InstrumentKind.

pub fn spot(base: &str, quote: &str) -> Result<Self, InvalidInstrumentId>

Shorthand for InstrumentId of kind InstrumentKind::Spot.

pub fn perp_linear(base: &str, quote: &str) -> Result<Self, InvalidInstrumentId>

Shorthand for InstrumentId of kind InstrumentKind::PerpetualLinear.

pub fn perp_inverse( base: &str, quote: &str, ) -> Result<Self, InvalidInstrumentId>

Shorthand for InstrumentId of kind InstrumentKind::PerpetualInverse.

pub fn as_str(&self) -> &str

pub fn kind(&self) -> InstrumentKind

pub fn base_asset(&self) -> Asset

pub fn quote_asset(&self) -> Asset

pub fn base_quote_assets(&self) -> (Asset, Asset)

Lightweight extraction of (base, quote) assets from the canonical ID string without constructing a full InstrumentKind.

All canonical formats place the pair as BASE-QUOTE after the first :. Futures add a second :EXPIRY suffix that is stripped.

Trait Implementations

impl Clone for InstrumentId

fn clone(&self) -> InstrumentId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstrumentId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstrumentId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InstrumentId

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

Formats the value using the given formatter.

impl From<InstrumentId> for String

fn from(id: InstrumentId) -> Self

Converts to this type from the input type.

impl FromStr for InstrumentId

type Err = InvalidInstrumentId

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for InstrumentId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for InstrumentId

fn cmp(&self, other: &InstrumentId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for InstrumentId

fn eq(&self, other: &InstrumentId) -> 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 PartialOrd for InstrumentId

fn partial_cmp(&self, other: &InstrumentId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for InstrumentId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for InstrumentId

type Error = InvalidInstrumentId

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for InstrumentId

impl StructuralPartialEq for InstrumentId