Skip to main content

OptionChainSlice

Struct OptionChainSlice 

Source
pub struct OptionChainSlice {
    pub series_id: OptionSeriesId,
    pub atm_strike: Option<Price>,
    pub calls: BTreeMap<Price, OptionStrikeData>,
    pub puts: BTreeMap<Price, OptionStrikeData>,
    pub ts_event: UnixNanos,
    pub ts_init: UnixNanos,
}
Expand description

A point-in-time snapshot of an option chain for a single series.

Fields§

§series_id: OptionSeriesId

The option series identifier.

§atm_strike: Option<Price>

The current ATM strike price (if determined).

§calls: BTreeMap<Price, OptionStrikeData>

Call option data keyed by strike price (sorted).

§puts: BTreeMap<Price, OptionStrikeData>

Put option data keyed by strike price (sorted).

§ts_event: UnixNanos

UNIX timestamp (nanoseconds) when the snapshot event occurred.

§ts_init: UnixNanos

UNIX timestamp (nanoseconds) when the instance was initialized.

Implementations§

Source§

impl OptionChainSlice

Source

pub fn new(series_id: OptionSeriesId) -> Self

Creates a new empty OptionChainSlice for the given series.

Source

pub fn call_count(&self) -> usize

Returns the number of call entries.

Source

pub fn put_count(&self) -> usize

Returns the number of put entries.

Source

pub fn get_call(&self, strike: &Price) -> Option<&OptionStrikeData>

Returns the call data for a given strike price.

Source

pub fn get_put(&self, strike: &Price) -> Option<&OptionStrikeData>

Returns the put data for a given strike price.

Source

pub fn get_call_quote(&self, strike: &Price) -> Option<&QuoteTick>

Returns the call quote for a given strike price.

Source

pub fn get_call_greeks(&self, strike: &Price) -> Option<&OptionGreeks>

Returns the call Greeks for a given strike price.

Source

pub fn get_put_quote(&self, strike: &Price) -> Option<&QuoteTick>

Returns the put quote for a given strike price.

Source

pub fn get_put_greeks(&self, strike: &Price) -> Option<&OptionGreeks>

Returns the put Greeks for a given strike price.

Source

pub fn strikes(&self) -> Vec<Price>

Returns all strike prices present in the chain (union of calls and puts).

Source

pub fn strike_count(&self) -> usize

Returns the total number of unique strikes.

Source

pub fn is_empty(&self) -> bool

Returns true if the chain has no data.

Trait Implementations§

Source§

impl Clone for OptionChainSlice

Source§

fn clone(&self) -> OptionChainSlice

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OptionChainSlice

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for OptionChainSlice

Source§

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

Formats the value using the given formatter. Read more
Source§

impl HasTsInit for OptionChainSlice

Source§

fn ts_init(&self) -> UnixNanos

Returns the UNIX timestamp (nanoseconds) when the instance was created.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.