Enum StatusReason

#[non_exhaustive]
#[repr(u16)]
pub enum StatusReason {
    None = 0,
    Scheduled = 1,
    SurveillanceIntervention = 2,
    MarketEvent = 3,
    InstrumentActivation = 4,
    InstrumentExpiration = 5,
    RecoveryInProcess = 6,
    Regulatory = 10,
    Administrative = 11,
    NonCompliance = 12,
    FilingsNotCurrent = 13,
    SecTradingSuspension = 14,
    NewIssue = 15,
    IssueAvailable = 16,
    IssuesReviewed = 17,
    FilingReqsSatisfied = 18,
    NewsPending = 30,
    NewsReleased = 31,
    NewsAndResumptionTimes = 32,
    NewsNotForthcoming = 33,
    OrderImbalance = 40,
    LuldPause = 50,
    Operational = 60,
    AdditionalInformationRequested = 70,
    MergerEffective = 80,
    Etf = 90,
    CorporateAction = 100,
    NewSecurityOffering = 110,
    MarketWideHaltLevel1 = 120,
    MarketWideHaltLevel2 = 121,
    MarketWideHaltLevel3 = 122,
    MarketWideHaltCarryover = 123,
    MarketWideHaltResumption = 124,
    QuotationNotAvailable = 130,
}

The secondary enum for a StatusMsg update, explains the cause of a halt or other change in action.

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.

None = 0

No reason is given.

Scheduled = 1

The change in status occurred as scheduled.

SurveillanceIntervention = 2

The instrument stopped due to a market surveillance intervention.

MarketEvent = 3

The status changed due to activity in the market.

InstrumentActivation = 4

The derivative instrument began trading.

InstrumentExpiration = 5

The derivative instrument expired.

RecoveryInProcess = 6

Recovery in progress.

Regulatory = 10

The status change was caused by a regulatory action.

Administrative = 11

The status change was caused by an administrative action.

NonCompliance = 12

The status change was caused by the issuer not being compliance with regulatory requirements.

FilingsNotCurrent = 13

Trading halted because the issuer’s filings are not current.

SecTradingSuspension = 14

Trading halted due to an SEC trading suspension.

NewIssue = 15

The status changed because a new issue is available.

IssueAvailable = 16

The status changed because an issue is available.

IssuesReviewed = 17

The status changed because the issue(s) were reviewed.

FilingReqsSatisfied = 18

The status changed because the filing requirements were satisfied.

NewsPending = 30

Relevant news is pending.

NewsReleased = 31

Relevant news was released.

NewsAndResumptionTimes = 32

The news has been fully disseminated and times are available for the resumption in quoting and trading.

NewsNotForthcoming = 33

The relevant news was not forthcoming.

OrderImbalance = 40

Halted for order imbalance.

LuldPause = 50

The instrument hit limit up or limit down.

Operational = 60

An operational issue occurred with the venue.

AdditionalInformationRequested = 70

The status changed until the exchange receives additional information.

MergerEffective = 80

Trading halted due to merger becoming effective.

Etf = 90

Trading is halted in an ETF due to conditions with the component securities.

CorporateAction = 100

Trading is halted for a corporate action.

NewSecurityOffering = 110

Trading is halted because the instrument is a new offering.

MarketWideHaltLevel1 = 120

Halted due to the market-wide circuit breaker level 1.

MarketWideHaltLevel2 = 121

Halted due to the market-wide circuit breaker level 2.

MarketWideHaltLevel3 = 122

Halted due to the market-wide circuit breaker level 3.

MarketWideHaltCarryover = 123

Halted due to the carryover of a market-wide circuit breaker from the previous trading day.

MarketWideHaltResumption = 124

Resumption due to the end of a market-wide circuit breaker halt.

QuotationNotAvailable = 130

Halted because quotation is not available.

Trait Implementations

impl Clone for StatusReason

fn clone(&self) -> StatusReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatusReason

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

Formats the value using the given formatter.

impl Default for StatusReason

fn default() -> StatusReason

Returns the “default value” for a type.

impl From<StatusReason> for u16

fn from(enum_value: StatusReason) -> Self

Converts to this type from the input type.

impl Hash for StatusReason

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 StatusReason

type Iterator = StatusReasonIter

fn iter() -> StatusReasonIter

impl<'py> IntoPyObject<'py> for StatusReason

type Target = StatusReason

The Python output type

type Output = Bound<'py, <StatusReason 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 Ord for StatusReason

fn cmp(&self, other: &StatusReason) -> 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 StatusReason

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

fn partial_cmp(&self, other: &StatusReason) -> 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 StatusReason

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for StatusReason

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

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<StatusReason>

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

Available on crate feature python only.

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

impl PyClass__eq__SlotFragment<StatusReason> for PyClassImplCollector<StatusReason>

Available on crate feature python only.

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

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

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

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

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

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

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

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

impl PyMethods<StatusReason> for PyClassImplCollector<StatusReason>

Available on crate feature python only.

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for StatusReason

const NAME: &'static str = "StatusReason"

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 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 TryFrom<u16> for StatusReason

type Error = TryFromPrimitiveError<StatusReason>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFromPrimitive for StatusReason

const NAME: &'static str = "StatusReason"

type Primitive = u16

type Error = TryFromPrimitiveError<StatusReason>

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

impl Copy for StatusReason

impl Eq for StatusReason

impl StructuralPartialEq for StatusReason