Struct Equity 

#[repr(C)]
pub struct Equity {

    pub id: InstrumentId,
    pub raw_symbol: Symbol,
    pub isin: Option<Ustr>,
    pub currency: Currency,
    pub price_precision: u8,
    pub price_increment: Price,
    pub margin_init: Decimal,
    pub margin_maint: Decimal,
    pub maker_fee: Decimal,
    pub taker_fee: Decimal,
    pub lot_size: Option<Quantity>,
    pub max_quantity: Option<Quantity>,
    pub min_quantity: Option<Quantity>,
    pub max_price: Option<Price>,
    pub min_price: Option<Price>,
    pub tick_scheme: Option<Ustr>,
    pub info: Option<Params>,
    pub ts_event: UnixNanos,
    pub ts_init: UnixNanos,
}

Represents a generic equity instrument.

Fields

id: InstrumentId

The instrument ID.

raw_symbol: Symbol

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

isin: Option<Ustr>

The instruments International Securities Identification Number (ISIN).

currency: Currency

The futures contract currency.

price_precision: u8

The price decimal precision.

price_increment: Price

The minimum price increment (tick size).

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.

lot_size: Option<Quantity>

The rounded lot unit size (standard/board).

max_quantity: Option<Quantity>

The maximum allowable order quantity.

min_quantity: Option<Quantity>

The minimum allowable order quantity.

max_price: Option<Price>

The maximum allowable quoted price.

min_price: Option<Price>

The minimum allowable quoted price.

tick_scheme: Option<Ustr>

The registered variable tick scheme name.

info: Option<Params>

Additional instrument metadata as a JSON-serializable dictionary.

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 Equity

pub fn new_checked( instrument_id: InstrumentId, raw_symbol: Symbol, isin: Option<Ustr>, currency: Currency, price_precision: u8, price_increment: Price, lot_size: Option<Quantity>, max_quantity: Option<Quantity>, min_quantity: Option<Quantity>, max_price: Option<Price>, min_price: Option<Price>, margin_init: Option<Decimal>, margin_maint: Option<Decimal>, maker_fee: Option<Decimal>, taker_fee: Option<Decimal>, tick_scheme: Option<Ustr>, info: Option<Params>, ts_event: UnixNanos, ts_init: UnixNanos, ) -> CorrectnessResult<Self>

Creates a new Equity instance with correctness checking.

Errors

Returns an error if any input validation fails.

Notes

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

pub fn new( instrument_id: InstrumentId, raw_symbol: Symbol, isin: Option<Ustr>, currency: Currency, price_precision: u8, price_increment: Price, lot_size: Option<Quantity>, max_quantity: Option<Quantity>, min_quantity: Option<Quantity>, max_price: Option<Price>, min_price: Option<Price>, margin_init: Option<Decimal>, margin_maint: Option<Decimal>, maker_fee: Option<Decimal>, taker_fee: Option<Decimal>, tick_scheme: Option<Ustr>, info: Option<Params>, ts_event: UnixNanos, ts_init: UnixNanos, ) -> Self

Creates a new Equity instance.

Panics

Panics if any parameter is invalid (see new_checked).

pub fn build_checked( instrument_id: InstrumentId, raw_symbol: Symbol, isin: Option<Ustr>, currency: Currency, price_precision: u8, price_increment: Price, lot_size: Option<Quantity>, max_quantity: Option<Quantity>, min_quantity: Option<Quantity>, max_price: Option<Price>, min_price: Option<Price>, margin_init: Option<Decimal>, margin_maint: Option<Decimal>, maker_fee: Option<Decimal>, taker_fee: Option<Decimal>, tick_scheme: Option<Ustr>, info: Option<Params>, ts_event: UnixNanos, ts_init: UnixNanos, ) -> CorrectnessResult<Self>

Returns a fluent builder for a Equity instance.

Required fields are enforced at compile time; optional fields can be omitted and default the same way they do in Equity::new_checked, which the builder calls so the same correctness checks run on build.

Errors

Returns an error if any input validation fails (see Equity::new_checked).

pub fn builder() -> EquityBuildCheckedBuilder

Returns a fluent builder for a Equity instance.

Required fields are enforced at compile time; optional fields can be omitted and default the same way they do in Equity::new_checked, which the builder calls so the same correctness checks run on build.

Errors

Returns an error if any input validation fails (see Equity::new_checked).

Trait Implementations

impl Clone for Equity

fn clone(&self) -> Equity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Equity

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

Formats the value using the given formatter.

impl DerefToPyAny for Equity

impl<'de> Deserialize<'de> for Equity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Equity

impl From<Equity> for InstrumentAny

fn from(v: Equity) -> InstrumentAny

Converts to this type from the input type.

impl<'a, 'py> FromPyObject<'a, 'py> for Equity

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl Hash for Equity

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 Equity

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

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 isin(&self) -> Option<Ustr>

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

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

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

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

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

fn is_inverse(&self) -> bool

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 margin_init(&self) -> Decimal

fn margin_maint(&self) -> Decimal

fn maker_fee(&self) -> Decimal

fn taker_fee(&self) -> Decimal

fn tick_scheme_rule(&self) -> Option<&dyn TickSchemeRule>

fn symbol(&self) -> Symbol

fn venue(&self) -> Venue

fn cost_currency(&self) -> Currency

Panics

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

fn has_expiration(&self) -> bool

fn allows_negative_price(&self) -> bool

fn is_quanto(&self) -> bool

fn min_price_increment_precision(&self) -> u8

fn min_size_increment_precision(&self) -> u8

fn try_make_price(&self, value: f64) -> Result<Price>

Errors

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

Panics

fn try_normalize_price(&self, price: Price) -> CorrectnessResult<Price>

Returns price rebuilt with the instrument precision when it is on the price grid.

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

Errors

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

Panics

fn try_normalize_qty(&self, quantity: Quantity) -> CorrectnessResult<Quantity>

Returns quantity rebuilt with the instrument precision when it is on the size grid.

fn try_calculate_base_quantity( &self, quantity: Quantity, last_price: Price, ) -> Result<Quantity>

Errors

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

Panics

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

Panics

fn next_bid_price(&self, value: f64, n: i32) -> Option<Price>

fn next_ask_price(&self, value: f64, n: i32) -> Option<Price>

fn next_bid_prices(&self, value: f64, n: usize) -> Vec<Price>

fn next_ask_prices(&self, value: f64, n: usize) -> Vec<Price>

impl<'py> IntoPyObject<'py> for Equity

type Target = Equity

The Python output type

type Output = Bound<'py, <Equity 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 Equity

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 Equity

const NAME: &str = "Equity"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Equity

const MODULE: Option<&str>

Module which the class will be associated with.

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)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Represents a generic equity instrument.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<Equity as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<Equity>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForEquity

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 lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for Equity

const TEXT_SIGNATURE: &'static str = "(instrument_id, raw_symbol, currency, price_precision, price_increment, ts_event, ts_init, isin=None, lot_size=None, max_quantity=None, min_quantity=None, max_price=None, min_price=None, margin_init=None, margin_maint=None, maker_fee=None, taker_fee=None, tick_scheme=None, info=None)"

impl PyStubType for Equity

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for Equity

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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 is_type_of(object: &Bound<'_, PyAny>) -> bool

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

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

Checks if object is an instance of this type.

impl Serialize for Equity

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryInto<Equity> for InstrumentAny

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.