Struct InstrumentMeta 

pub struct InstrumentMeta {
    pub symbol: String,
    pub tick_size: f64,
    pub price_precision: usize,
    pub timezone: String,
}

Provider-neutral instrument metadata.

Fields

symbol: String

tick_size: f64

price_precision: usize

timezone: String

Implementations

impl InstrumentMeta

pub fn validate(&self) -> Result<(), InstrumentMetaError>

Validates the operative contract required to use this metadata for rounding, risk and session calculations: a finite positive tick size, a sane price precision, and non-empty symbol/timezone identifiers.

pub fn round_to_tick(&self, price: f64) -> f64

Rounds price to the nearest multiple of InstrumentMeta::tick_size.

Returns price unchanged if tick_size is non-finite or non-positive, so this method is safe to call on unvalidated metadata (see InstrumentMeta::validate to reject that case explicitly at ingestion boundaries).

Trait Implementations

impl Clone for InstrumentMeta

fn clone(&self) -> InstrumentMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstrumentMeta

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

Formats the value using the given formatter.

impl Default for InstrumentMeta

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InstrumentMeta

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InstrumentMeta

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for InstrumentMeta

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 InstrumentMeta