Struct Instrument 

pub struct Instrument {
    pub symbol: Symbol,
    pub exchange: Option<Exchange>,
    pub figi: Option<Figi>,
    pub isin: Option<Isin>,
    pub kind: AssetKind,
}

Logical instrument identity for a security.

Fields

symbol: Symbol

Canonical ticker symbol.

exchange: Option<Exchange>

Optional trading venue context for disambiguation.

figi: Option<Figi>

Optional global identifier (preferred).

isin: Option<Isin>

Optional global identifier (fallback).

kind: AssetKind

Asset class and behavior.

Implementations

impl Instrument

pub const fn new(symbol: Symbol, kind: AssetKind) -> Instrument

Construct an instrument from a validated symbol and asset kind.

pub fn from_symbol( symbol: impl AsRef<str>, kind: AssetKind, ) -> Result<Instrument, DomainError>

Construct a new Instrument with just a symbol and kind.

Errors

Returns DomainError::InvalidSymbol if the provided symbol violates canonical invariants.

pub fn from_symbol_and_exchange( symbol: impl AsRef<str>, exchange: Exchange, kind: AssetKind, ) -> Result<Instrument, DomainError>

Construct a new Instrument with symbol, exchange, and kind.

Errors

Returns DomainError::InvalidSymbol if the provided symbol violates canonical invariants.

pub fn from_figi( figi: &str, symbol: Symbol, kind: AssetKind, ) -> Result<Instrument, DomainError>

Construct a new Instrument for a security identified by a FIGI and symbol.

Errors

Returns DomainError::InvalidFigi if FIGI validation fails.

pub fn unique_key(&self) -> String

Returns a stable, namespaced identity key for this instrument.

The key includes the asset kind and identifier source so instruments that share a raw symbol (for example, an equity and a crypto asset both named BTC) do not collapse to the same key. Symbol payloads include their byte length to avoid delimiter collisions with symbols that contain characters such as @.

This is a synthetic composite key and is always returned as an owned String. Use Self::display_key when a compact display identifier is needed.

pub fn display_key(&self) -> Cow<'_, str>

Returns the best available compact identifier for display (FIGI > ISIN > SYMBOL@EXCHANGE > SYMBOL).

Trait Implementations

impl Clone for Instrument

fn clone(&self) -> Instrument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Columnar for Instrument

where Symbol: AsRef<str>, Exchange: AsRef<str>, Figi: AsRef<str>, Isin: AsRef<str>, AssetKind: AsRef<str>,

fn columnar_to_dataframe(items: &[Instrument]) -> Result<DataFrame, PolarsError>

Errors

fn columnar_from_refs(items: &[&Instrument]) -> Result<DataFrame, PolarsError>

Errors

impl Debug for Instrument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Instrument

fn deserialize<__D>( __deserializer: __D, ) -> Result<Instrument, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Instrument

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

Formats the value using the given formatter.

impl Eq for Instrument

impl Hash for Instrument

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

where __H: Hasher,

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 Instrument

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Instrument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Instrument

impl ToDataFrame for Instrument

where Symbol: AsRef<str>, Exchange: AsRef<str>, Figi: AsRef<str>, Isin: AsRef<str>, AssetKind: AsRef<str>,

fn to_dataframe(&self) -> Result<DataFrame, PolarsError>

Errors

fn empty_dataframe() -> Result<DataFrame, PolarsError>

Errors

fn schema() -> Result<Vec<(String, DataType)>, PolarsError>

Errors