Struct Instrument 

pub struct Instrument<ExchangeKey, AssetKey> {
    pub exchange: ExchangeKey,
    pub name_internal: InstrumentNameInternal,
    pub name_exchange: InstrumentNameExchange,
    pub underlying: Underlying<AssetKey>,
    pub quote: InstrumentQuoteAsset,
    pub kind: InstrumentKind<AssetKey>,
    pub spec: Option<InstrumentSpec<AssetKey>>,
}

Comprehensive Instrument model, containing all the data required to subscribe to market data and generate correct orders.

Fields

exchange: ExchangeKey

name_internal: InstrumentNameInternal

name_exchange: InstrumentNameExchange

underlying: Underlying<AssetKey>

quote: InstrumentQuoteAsset

kind: InstrumentKind<AssetKey>

spec: Option<InstrumentSpec<AssetKey>>

Implementations

impl<ExchangeKey, AssetKey> Instrument<ExchangeKey, AssetKey>

pub fn new<NameInternal, NameExchange>( exchange: ExchangeKey, name_internal: NameInternal, name_exchange: NameExchange, underlying: Underlying<AssetKey>, quote: InstrumentQuoteAsset, kind: InstrumentKind<AssetKey>, spec: Option<InstrumentSpec<AssetKey>>, ) -> Self

where NameInternal: Into<InstrumentNameInternal>, NameExchange: Into<InstrumentNameExchange>,

Construct a new Instrument with the provided data.

This constructor assumes the InstrumentNameInternal can be constructed in the default style via the InstrumentNameInternal::new_from_exchange constructor.

pub fn spot<NameInternal, NameExchange>( exchange: ExchangeKey, name_internal: NameInternal, name_exchange: NameExchange, underlying: Underlying<AssetKey>, spec: Option<InstrumentSpec<AssetKey>>, ) -> Self

where NameInternal: Into<InstrumentNameInternal>, NameExchange: Into<InstrumentNameExchange>,

Construct a new Spot Instrument with the provided data.

This constructor assumes the InstrumentNameInternal can be constructed in the default style via the InstrumentNameInternal::new_from_exchange constructor.

pub fn map_exchange_key<NewExchangeKey>( self, exchange: NewExchangeKey, ) -> Instrument<NewExchangeKey, AssetKey>

Map this Instruments ExchangeKey to a new key.

pub fn map_asset_key_with_lookup<FnFindAsset, NewAssetKey, Error>( self, find_asset: FnFindAsset, ) -> Result<Instrument<ExchangeKey, NewAssetKey>, Error>

where FnFindAsset: Fn(&AssetKey) -> Result<NewAssetKey, Error>,

Map this Instruments AssetKey to a new key, using the provided lookup closure.

Trait Implementations

impl<ExchangeKey: Clone, AssetKey: Clone> Clone for Instrument<ExchangeKey, AssetKey>

fn clone(&self) -> Instrument<ExchangeKey, AssetKey>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<ExchangeKey: Debug, AssetKey: Debug> Debug for Instrument<ExchangeKey, AssetKey>

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

Formats the value using the given formatter.

impl<'de, ExchangeKey, AssetKey> Deserialize<'de> for Instrument<ExchangeKey, AssetKey>

where ExchangeKey: Deserialize<'de>, AssetKey: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<ExchangeKey> From<&Instrument<ExchangeKey, Asset>> for MarketDataInstrument

fn from(value: &Instrument<ExchangeKey, Asset>) -> Self

Converts to this type from the input type.

impl<ExchangeKey: Hash, AssetKey: Hash> Hash for Instrument<ExchangeKey, AssetKey>

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<ExchangeKey: Ord, AssetKey: Ord> Ord for Instrument<ExchangeKey, AssetKey>

fn cmp(&self, other: &Instrument<ExchangeKey, AssetKey>) -> 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<ExchangeKey: PartialEq, AssetKey: PartialEq> PartialEq for Instrument<ExchangeKey, AssetKey>

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

fn partial_cmp( &self, other: &Instrument<ExchangeKey, AssetKey>, ) -> 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<ExchangeKey, AssetKey> Serialize for Instrument<ExchangeKey, AssetKey>

where ExchangeKey: Serialize, AssetKey: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<ExchangeKey: Eq, AssetKey: Eq> Eq for Instrument<ExchangeKey, AssetKey>

impl<ExchangeKey, AssetKey> StructuralPartialEq for Instrument<ExchangeKey, AssetKey>