Enum InstrumentClass 

#[repr(C)]
pub enum InstrumentClass {
    Spot = 1,
    Swap = 2,
    Future = 3,
    FuturesSpread = 4,
    Forward = 5,
    Cfd = 6,
    Bond = 7,
    Option = 8,
    OptionSpread = 9,
    Warrant = 10,
    SportsBetting = 11,
    BinaryOption = 12,
}

The instrument class.

Variants

Spot = 1

A spot market instrument class. The current market price of an instrument that is bought or sold for immediate delivery and payment.

Swap = 2

A swap instrument class. A derivative contract through which two parties exchange the cash flows or liabilities from two different financial instruments.

Future = 3

A futures contract instrument class. A legal agreement to buy or sell an asset at a predetermined price at a specified time in the future.

FuturesSpread = 4

A futures spread instrument class. A strategy involving the use of futures contracts to take advantage of price differentials between different contract months, underlying assets, or marketplaces.

Forward = 5

A forward derivative instrument class. A customized contract between two parties to buy or sell an asset at a specified price on a future date.

Cfd = 6

A contract-for-difference (CFD) instrument class. A contract between an investor and a CFD broker to exchange the difference in the value of a financial product between the time the contract opens and closes.

Bond = 7

A bond instrument class. A type of debt investment where an investor loans money to an entity (typically corporate or governmental) which borrows the funds for a defined period of time at a variable or fixed interest rate.

Option = 8

An option contract instrument class. A type of derivative that gives the holder the right, but not the obligation, to buy or sell an underlying asset at a predetermined price before or at a certain future date.

OptionSpread = 9

An option spread instrument class. A strategy involving the purchase and/or sale of multiple option contracts on the same underlying asset with different strike prices or expiration dates to hedge risk or speculate on price movements.

Warrant = 10

A warrant instrument class. A derivative that gives the holder the right, but not the obligation, to buy or sell a security—most commonly an equity—at a certain price before expiration.

SportsBetting = 11

A sports betting instrument class. A financialized derivative that allows wagering on the outcome of sports events using structured contracts or prediction markets.

BinaryOption = 12

A binary option instrument class. A type of derivative where the payoff is either a fixed monetary amount or nothing, depending on whether the price of an underlying asset is above or below a predetermined level at expiration.

Implementations

impl InstrumentClass

pub const fn from_repr(discriminant: usize) -> Option<InstrumentClass>

Try to create Self from the raw representation

impl InstrumentClass

pub const fn has_expiration(&self) -> bool

Returns whether this instrument class has an expiration.

pub const fn allows_negative_price(&self) -> bool

Returns whether this instrument class allows negative prices.

impl InstrumentClass

pub fn name(&self) -> String

pub fn value(&self) -> u8

Trait Implementations

impl AsRef<str> for InstrumentClass

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for InstrumentClass

fn clone(&self) -> InstrumentClass

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstrumentClass

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstrumentClass

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InstrumentClass

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

Formats the value using the given formatter.

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

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 FromStr for InstrumentClass

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<InstrumentClass, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for InstrumentClass

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 IntoEnumIterator for InstrumentClass

type Iterator = InstrumentClassIter

fn iter() -> InstrumentClassIter

impl<'py> IntoPyObject<'py> for InstrumentClass

type Target = InstrumentClass

The Python output type

type Output = Bound<'py, <InstrumentClass 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<'py>>::Output, <Self as IntoPyObject<'py>>::Error>

Performs the conversion.

impl Ord for InstrumentClass

fn cmp(&self, other: &InstrumentClass) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for InstrumentClass

fn eq(&self, other: &InstrumentClass) -> 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 PartialOrd for InstrumentClass

fn partial_cmp(&self, other: &InstrumentClass) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PyClass for InstrumentClass

const NAME: &str = "InstrumentClass"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for InstrumentClass

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 = /// The instrument class.

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 = <<InstrumentClass as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<InstrumentClass>

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 = Pyo3MethodsInventoryForInstrumentClass

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

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 InstrumentClass

const TEXT_SIGNATURE: &'static str = "(value)"

impl PyStubType for InstrumentClass

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 InstrumentClass

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 InstrumentClass

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for InstrumentClass

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<InstrumentClass, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for InstrumentClass

impl Eq for InstrumentClass

impl StructuralPartialEq for InstrumentClass