Enum InstrumentClass 

#[non_exhaustive]
#[repr(u8)]
pub enum InstrumentClass {
    Bond = 66,
    Call = 67,
    Future = 70,
    Stock = 75,
    MixedSpread = 77,
    Put = 80,
    FutureSpread = 83,
    OptionSpread = 84,
    FxSpot = 88,
    CommoditySpot = 89,
}

The class of instrument.

For example usage see Getting options with their underlying.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bond = 66

A bond.

Call = 67

A call option.

Future = 70

A future.

Stock = 75

A stock.

MixedSpread = 77

A spread composed of multiple instrument classes.

Put = 80

A put option.

FutureSpread = 83

A spread composed of futures.

OptionSpread = 84

A spread composed of options.

FxSpot = 88

A foreign exchange spot.

CommoditySpot = 89

A commodity being traded for immediate delivery.

Implementations

impl InstrumentClass

pub fn is_option(&self) -> bool

Returns true if the instrument class is a type of option.

Note: excludes Self::MixedSpread, which may include options.

pub fn is_future(&self) -> bool

Returns true if the instrument class is a type of future.

Note: excludes Self::MixedSpread, which may include futures.

pub fn is_spread(&self) -> bool

Returns true if the instrument class is a type of spread, i.e. composed of two or more instrument legs.

Trait Implementations

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 From<InstrumentClass> for char

fn from(value: InstrumentClass) -> Self

Converts to this type from the input type.

impl From<InstrumentClass> for u8

fn from(enum_value: InstrumentClass) -> Self

Converts to this type from the input type.

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

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 class of instrument. /// /// For example usage see /// [Getting options with their underlying](https://databento.com/docs/examples/options/options-and-futures).

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

Available on crate feature python only.

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

impl PyClass__eq__SlotFragment<InstrumentClass> for PyClassImplCollector<InstrumentClass>

Available on crate feature python only.

unsafe fn __eq__( self, py: Python<'_>, _slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyMethods<InstrumentClass> for PyClassImplCollector<InstrumentClass>

Available on crate feature python only.

fn py_methods(self) -> &'static PyClassItems

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

type Error = TryFromPrimitiveError<InstrumentClass>

The type returned in the event of a conversion error.

fn try_from(number: u8) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for InstrumentClass

const NAME: &'static str = "InstrumentClass"

type Primitive = u8

type Error = TryFromPrimitiveError<InstrumentClass>

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl WritePyRepr for InstrumentClass

Available on crate feature python only.

fn write_py_repr(&self, s: &mut String) -> Result

Writes a Python-style string representation to s.

const SHOULD_FLATTEN: bool = false

Whether this type’s fields should be flattened into the parent repr.

impl Copy for InstrumentClass

impl Eq for InstrumentClass

impl StructuralPartialEq for InstrumentClass