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 instance was created.

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.

Trait Implementations

impl Clone for InstrumentStatus

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for InstrumentStatus

impl Debug for InstrumentStatus

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

Formats the value using the given formatter.

impl DerefToPyAny for InstrumentStatus

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

impl From<InstrumentStatus> for Data

fn from(value: InstrumentStatus) -> Self

Converts to this type from the input type.

impl FromDataBatch for InstrumentStatus

fn from_batch(batch: DataBatch) -> Result<Vec<Self>>

Unwraps a typed batch into owned values.

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

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

fn ts_init(&self) -> UnixNanos

Returns the UNIX timestamp (nanoseconds) when the instance was created.

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

fn into_batch(data: Vec<Self>) -> DataBatch

Wraps owned typed values in their DataBatch variant.

impl<'py> IntoPyObject<'py> for InstrumentStatus

type Target = InstrumentStatus

The Python output type

type Output = Bound<'py, InstrumentStatus>

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>) -> PyResult<Bound<'py, Self>>

Performs the conversion.

impl PartialEq for InstrumentStatus

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

Equality operator ==.

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

Inequality operator !=.

impl PyClass for InstrumentStatus

const NAME: &str = "InstrumentStatus"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for InstrumentStatus

const MODULE: Option<&str>

Module which the class will be associated with.

const RAW_DOC: &'static CStr = /// Represents an event that indicates a change in an instrument market status.

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

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

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 __traverse__(&self, visit: PyVisit<'_>) -> Result<(), PyTraverseError>

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

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 InstrumentStatus

const TEXT_SIGNATURE: &'static str = "(instrument_id, action, ts_event, ts_init, reason=None, trading_event=None, is_trading=None, is_quoting=None, is_short_sell_restricted=None)"

impl PyStubType for InstrumentStatus

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 InstrumentStatus

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

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

Deserialize an object from JSON encoded bytes.

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

Serialize an object to JSON 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 StructuralPartialEq for InstrumentStatus

impl TryFrom<Data> for InstrumentStatus

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Data) -> Result<Self, Self::Error>

Performs the conversion.