Struct InstrumentKey 

pub struct InstrumentKey {
    pub ticker: String,
    pub class_code: String,
}

Names one instrument for the broker: a ticker and a class code (board).

The same ticker can trade on several boards (for example SBER on TQBR), so the broker always wants both. The class code is the code of the board on the exchange, TQBR for most Russian shares.

Examples

use brokapi_bcs_protocol::models::instrument::InstrumentKey;

let key = InstrumentKey::new("SBER", "TQBR");
assert_eq!(serde_json::to_string(&key)?, r#"{"ticker":"SBER","classCode":"TQBR"}"#);

Fields

ticker: String

Exchange ticker, for example SBER.

class_code: String

Class code (board) of the ticker, for example TQBR.

Implementations

impl InstrumentKey

pub fn new(ticker: impl Into<String>, class_code: impl Into<String>) -> Self

Builds a key from a ticker and a class code.

Examples

use brokapi_bcs_protocol::models::instrument::InstrumentKey;

let key = InstrumentKey::new(String::from("GAZP"), "TQBR");
assert_eq!((key.ticker.as_str(), key.class_code.as_str()), ("GAZP", "TQBR"));

Trait Implementations

impl Clone for InstrumentKey

fn clone(&self) -> InstrumentKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstrumentKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstrumentKey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for InstrumentKey

impl Hash for InstrumentKey

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

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

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 InstrumentKey