Enum InstrumentClass

#[repr(C)]
pub enum InstrumentClass {
    Spot = 1,
    Swap = 2,
    Future = 3,
    FutureSpread = 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.

FutureSpread = 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 options 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 options on the same underlying asset with different strike prices or expiration dates to capitalize on expected market moves in a controlled cost environment.

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 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.

BinaryOption = 12

A binary option instrument class. A type of derivative where the payoff is either a fixed monetary amount or nothing, based on a yes/no proposition about an underlying event.

Implementations

impl InstrumentClass

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

Try to create Self from the raw representation

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 copy 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 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 IntoPy<Py<PyAny>> for InstrumentClass

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

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for InstrumentClass

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

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

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

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a InstrumentClass

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

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

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut InstrumentClass

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

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

impl PyMethods<InstrumentClass> for PyClassImplCollector<InstrumentClass>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for InstrumentClass

const NAME: &'static str = "InstrumentClass"

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_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

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

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

fn is_exact_type_of_bound(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