Struct Instrument

pub struct Instrument {
    pub instrument_token: u32,
    pub exchange_token: u32,
    pub trading_symbol: String,
    pub name: String,
    pub last_price: f64,
    pub expiry: Option<NaiveDate>,
    pub strike: f64,
    pub tick_size: f64,
    pub lot_size: u32,
    pub instrument_type: InstrumentType,
    pub segment: Segment,
    pub exchange: Exchange,
}

Instrument data structure

Fields

instrument_token: u32

Instrument token (unique identifier)

exchange_token: u32

Exchange token

trading_symbol: String

Trading symbol

name: String

Company name or instrument name

last_price: f64

Last price

expiry: Option<NaiveDate>

Expiry date (for derivatives, None for equity)

strike: f64

Strike price (for options, 0.0 for others)

tick_size: f64

Tick size (minimum price movement)

lot_size: u32

Lot size (minimum quantity for trading)

instrument_type: InstrumentType

Instrument type

segment: Segment

Segment

exchange: Exchange

Exchange

Implementations

impl Instrument

pub fn is_equity(&self) -> bool

Check if the instrument is an equity

pub fn is_future(&self) -> bool

Check if the instrument is a future

pub fn is_option(&self) -> bool

Check if the instrument is an option

pub fn is_call_option(&self) -> bool

Check if the instrument is a call option

pub fn is_put_option(&self) -> bool

Check if the instrument is a put option

pub fn is_expired(&self) -> bool

Check if the instrument has expired

pub fn expires_today(&self) -> bool

Check if the instrument expires today

pub fn days_to_expiry(&self) -> Option<i64>

Get days to expiry (None for non-expiring instruments)

pub fn is_itm(&self, underlying_price: f64) -> Option<bool>

Check if the instrument is in-the-money (for options)

pub fn is_atm(&self, underlying_price: f64, tolerance: f64) -> Option<bool>

Check if the instrument is at-the-money (for options)

pub fn is_otm(&self, underlying_price: f64) -> Option<bool>

Check if the instrument is out-of-the-money (for options)

pub fn intrinsic_value(&self, underlying_price: f64) -> Option<f64>

Calculate intrinsic value (for options)

pub fn tick_value(&self) -> f64

Calculate the tick value in rupees

Trait Implementations

impl Clone for Instrument

fn clone(&self) -> Instrument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instrument

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Instrument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.