Struct InstrumentStatus

#[repr(C)]
pub struct InstrumentStatus {
    pub instrument_id: InstrumentId,
    pub action: MarketStatusAction,
    pub ts_event: UnixNanos,
    pub ts_init: UnixNanos,
    pub reason: Option<Ustr>,
    pub trading_event: Option<Ustr>,
    pub is_trading: Option<bool>,
    pub is_quoting: Option<bool>,
    pub is_short_sell_restricted: Option<bool>,
}

Represents an event that indicates a change in an instrument market status.

Fields

instrument_id: InstrumentId

The instrument ID for the status change.

action: MarketStatusAction

The instrument market status action.

ts_event: UnixNanos

UNIX timestamp (nanoseconds) when the status event occurred.

ts_init: UnixNanos

UNIX timestamp (nanoseconds) when the struct was initialized.

reason: Option<Ustr>

Additional details about the cause of the status change.

trading_event: Option<Ustr>

Further information about the status change (if provided).

is_trading: Option<bool>

The state of trading in the instrument.

is_quoting: Option<bool>

The state of quoting in the instrument.

is_short_sell_restricted: Option<bool>

The state of short sell restrictions for the instrument (if applicable).

Implementations

impl InstrumentStatus

pub fn new( instrument_id: InstrumentId, action: MarketStatusAction, ts_event: UnixNanos, ts_init: UnixNanos, reason: Option<Ustr>, trading_event: Option<Ustr>, is_trading: Option<bool>, is_quoting: Option<bool>, is_short_sell_restricted: Option<bool>, ) -> Self

Creates a new InstrumentStatus instance.

pub fn get_metadata(instrument_id: &InstrumentId) -> HashMap<String, String>

Returns the metadata for the type, for use with serialization formats.

impl InstrumentStatus

pub fn from_pyobject(obj: &Bound<'_, PyAny>) -> PyResult<Self>

Creates a new InstrumentStatus from a Python object.

Errors

Returns a PyErr if extracting any attribute or converting types fails.

Panics

Panics if converting action_u16 to MarketStatusAction fails.

Trait Implementations

impl Clone for InstrumentStatus

fn clone(&self) -> InstrumentStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstrumentStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstrumentStatus

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InstrumentStatus

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

Formats the value using the given formatter.

impl GetTsInit for InstrumentStatus

fn ts_init(&self) -> UnixNanos

impl Hash for InstrumentStatus

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

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 InstrumentStatus

type Target = InstrumentStatus

The Python output type

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

fn eq(&self, other: &InstrumentStatus) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 InstrumentStatus

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for InstrumentStatus

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

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

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

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

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

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

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

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

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

impl PyMethods<InstrumentStatus> for PyClassImplCollector<InstrumentStatus>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for InstrumentStatus

const NAME: &'static str = "InstrumentStatus"

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 Serializable for InstrumentStatus

fn from_json_bytes(data: &[u8]) -> Result<Self, Error>

Deserialize an object from JSON encoded bytes.

fn from_msgpack_bytes(data: &[u8]) -> Result<Self, Error>

Deserialize an object from MsgPack encoded bytes.

fn to_json_bytes(&self) -> Result<Bytes, Error>

Serialize an object to JSON encoded bytes.

fn to_msgpack_bytes(&self) -> Result<Bytes, Error>

Serialize an object to MsgPack encoded bytes.

impl Serialize for InstrumentStatus

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for InstrumentStatus

impl DerefToPyAny for InstrumentStatus

impl Eq for InstrumentStatus

impl StructuralPartialEq for InstrumentStatus