Struct CryptoOption

#[repr(C)]
pub struct CryptoOption {

    pub id: InstrumentId,
    pub raw_symbol: Symbol,
    pub underlying: Currency,
    pub quote_currency: Currency,
    pub settlement_currency: Currency,
    pub is_inverse: bool,
    pub option_kind: OptionKind,
    pub strike_price: Price,
    pub activation_ns: UnixNanos,
    pub expiration_ns: UnixNanos,
    pub price_precision: u8,
    pub size_precision: u8,
    pub price_increment: Price,
    pub size_increment: Quantity,
    pub multiplier: Quantity,
    pub lot_size: Quantity,
    pub margin_init: Decimal,
    pub margin_maint: Decimal,
    pub maker_fee: Decimal,
    pub taker_fee: Decimal,
    pub max_quantity: Option<Quantity>,
    pub min_quantity: Option<Quantity>,
    pub max_notional: Option<Money>,
    pub min_notional: Option<Money>,
    pub max_price: Option<Price>,
    pub min_price: Option<Price>,
    pub ts_event: UnixNanos,
    pub ts_init: UnixNanos,
}

Represents a generic option contract instrument.

Fields

id: InstrumentId

The instrument ID.

raw_symbol: Symbol

The raw/local/native symbol for the instrument, assigned by the venue.

underlying: Currency

The underlying asset.

quote_currency: Currency

The contract quote currency.

settlement_currency: Currency

The settlement currency.

is_inverse: bool

If the instrument costing is inverse (quantity expressed in quote currency units).

option_kind: OptionKind

The kind of option (PUT | CALL).

strike_price: Price

The option strike price.

activation_ns: UnixNanos

UNIX timestamp (nanoseconds) for contract activation.

expiration_ns: UnixNanos

UNIX timestamp (nanoseconds) for contract expiration.

price_precision: u8

The option contract currency.

size_precision: u8

The trading size decimal precision.

price_increment: Price

The minimum price increment (tick size).

size_increment: Quantity

The minimum size increment.

multiplier: Quantity

The option multiplier.

lot_size: Quantity

The rounded lot unit size (standard/board).

margin_init: Decimal

The initial (order) margin requirement in percentage of order value.

margin_maint: Decimal

The maintenance (position) margin in percentage of position value.

maker_fee: Decimal

The fee rate for liquidity makers as a percentage of order value.

taker_fee: Decimal

The fee rate for liquidity takers as a percentage of order value.

max_quantity: Option<Quantity>

The maximum allowable order quantity.

min_quantity: Option<Quantity>

The minimum allowable order quantity.

max_notional: Option<Money>

The maximum allowable order notional value.

min_notional: Option<Money>

The minimum allowable order notional value.

max_price: Option<Price>

The maximum allowable quoted price.

min_price: Option<Price>

The minimum allowable quoted price.

ts_event: UnixNanos

UNIX timestamp (nanoseconds) when the data event occurred.

ts_init: UnixNanos

UNIX timestamp (nanoseconds) when the data object was initialized.

Implementations

impl CryptoOption

pub fn new_checked( instrument_id: InstrumentId, raw_symbol: Symbol, underlying: Currency, quote_currency: Currency, settlement_currency: Currency, is_inverse: bool, option_kind: OptionKind, strike_price: Price, activation_ns: UnixNanos, expiration_ns: UnixNanos, price_precision: u8, size_precision: u8, price_increment: Price, size_increment: Quantity, multiplier: Option<Quantity>, max_quantity: Option<Quantity>, min_quantity: Option<Quantity>, max_notional: Option<Money>, min_notional: Option<Money>, max_price: Option<Price>, min_price: Option<Price>, margin_init: Option<Decimal>, margin_maint: Option<Decimal>, maker_fee: Option<Decimal>, taker_fee: Option<Decimal>, ts_event: UnixNanos, ts_init: UnixNanos, ) -> Result<Self>

Creates a new CryptoOption instance with correctness checking.

Notes

PyO3 requires a Result type for proper error handling and stacktrace printing in Python.

Errors

Returns an error if any input validation fails.

pub fn new( instrument_id: InstrumentId, raw_symbol: Symbol, underlying: Currency, quote_currency: Currency, settlement_currency: Currency, is_inverse: bool, option_kind: OptionKind, strike_price: Price, activation_ns: UnixNanos, expiration_ns: UnixNanos, price_precision: u8, size_precision: u8, price_increment: Price, size_increment: Quantity, multiplier: Option<Quantity>, max_quantity: Option<Quantity>, min_quantity: Option<Quantity>, max_notional: Option<Money>, min_notional: Option<Money>, max_price: Option<Price>, min_price: Option<Price>, margin_init: Option<Decimal>, margin_maint: Option<Decimal>, maker_fee: Option<Decimal>, taker_fee: Option<Decimal>, ts_event: UnixNanos, ts_init: UnixNanos, ) -> Self

Creates a new CryptoOption instance.

Panics

Panics if any parameter is invalid (see new_checked).

Trait Implementations

impl Clone for CryptoOption

fn clone(&self) -> CryptoOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CryptoOption

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CryptoOption

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CryptoOption> for InstrumentAny

fn from(v: CryptoOption) -> InstrumentAny

Converts to this type from the input type.

impl Hash for CryptoOption

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 Instrument for CryptoOption

fn into_any(self) -> InstrumentAny

fn id(&self) -> InstrumentId

fn raw_symbol(&self) -> Symbol

fn asset_class(&self) -> AssetClass

fn instrument_class(&self) -> InstrumentClass

fn underlying(&self) -> Option<Ustr>

fn base_currency(&self) -> Option<Currency>

fn quote_currency(&self) -> Currency

fn settlement_currency(&self) -> Currency

fn is_inverse(&self) -> bool

fn isin(&self) -> Option<Ustr>

fn option_kind(&self) -> Option<OptionKind>

fn strike_price(&self) -> Option<Price>

fn activation_ns(&self) -> Option<UnixNanos>

fn expiration_ns(&self) -> Option<UnixNanos>

fn exchange(&self) -> Option<Ustr>

fn price_precision(&self) -> u8

fn size_precision(&self) -> u8

fn price_increment(&self) -> Price

fn size_increment(&self) -> Quantity

fn multiplier(&self) -> Quantity

fn lot_size(&self) -> Option<Quantity>

fn max_quantity(&self) -> Option<Quantity>

fn min_quantity(&self) -> Option<Quantity>

fn max_notional(&self) -> Option<Money>

fn min_notional(&self) -> Option<Money>

fn max_price(&self) -> Option<Price>

fn min_price(&self) -> Option<Price>

fn ts_event(&self) -> UnixNanos

fn ts_init(&self) -> UnixNanos

fn symbol(&self) -> Symbol

fn venue(&self) -> Venue

fn cost_currency(&self) -> Currency

fn is_quanto(&self) -> bool

fn margin_init(&self) -> Decimal

fn margin_maint(&self) -> Decimal

fn maker_fee(&self) -> Decimal

fn taker_fee(&self) -> Decimal

fn make_price(&self, value: f64) -> Price

Creates a new Price from the given value with the correct price precision for the instrument.

fn make_qty(&self, value: f64, round_down: Option<bool>) -> Quantity

Creates a new Quantity from the given value with the correct size precision for the instrument.

fn calculate_notional_value( &self, quantity: Quantity, price: Price, use_quote_for_inverse: Option<bool>, ) -> Money

Calculates the notional value from the given parameters. The use_quote_for_inverse flag is only applicable for inverse instruments.

fn calculate_base_quantity( &self, quantity: Quantity, last_px: Price, ) -> Quantity

Returns the equivalent quantity of the base asset.

impl IntoPy<Py<PyAny>> for CryptoOption

fn into_py(self, py: Python<'_>) -> PyObject

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

impl<'py> IntoPyObject<'py> for CryptoOption

type Target = CryptoOption

The Python output type

type Output = Bound<'py, <CryptoOption as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for CryptoOption

fn eq(&self, other: &Self) -> 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 PyClass for CryptoOption

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for CryptoOption

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<CryptoOption>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<CryptoOption> for PyClassImplCollector<CryptoOption>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a CryptoOption

type Holder = Option<PyRef<'py, CryptoOption>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut CryptoOption

type Holder = Option<PyRefMut<'py, CryptoOption>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<CryptoOption> for PyClassImplCollector<CryptoOption>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for CryptoOption

const NAME: &'static str = "CryptoOption"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for [PyTypeInfo::type_object].

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for [PyTypeInfo::is_type_of].

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for [PyTypeInfo::is_exact_type_of].

impl Serialize for CryptoOption

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryInto<CryptoOption> for InstrumentAny

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<CryptoOption, <Self as TryInto<CryptoOption>>::Error>

Performs the conversion.

impl Copy for CryptoOption

impl DerefToPyAny for CryptoOption

impl Eq for CryptoOption