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

fn path_prefix() -> &'static str

Returns the path prefix (directory name) for this data type.

impl Clone for InstrumentStatus

fn clone(&self) -> InstrumentStatus

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<'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 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 PartialEq for InstrumentStatus

fn eq(&self, other: &InstrumentStatus) -> 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 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.