Enum AxInstrumentState 

pub enum AxInstrumentState {
    PreOpen,
    Open,
    Closed,
    ClosedFrozen,
    Halted,
    MatchAndCloseAuction,
    Suspended,
    Delisted,
    Unknown,
}

Instrument state as returned by the AX Exchange API.

References

• https://docs.architect.exchange/api-reference/symbols-instruments/get-instruments

Variants

PreOpen

Instrument is in pre-open state.

Open

Instrument is open for trading.

Closed

Instrument trading is closed.

ClosedFrozen

Instrument trading is closed and frozen.

Halted

Instrument trading is halted.

MatchAndCloseAuction

Instrument is in a match-and-close auction.

Suspended

Instrument trading is suspended.

Delisted

Instrument has been delisted.

Unknown

Instrument state is unknown.

Implementations

impl AxInstrumentState

pub fn is_tradeable(self) -> bool

Returns whether the instrument is in a tradeable state.

Trait Implementations

impl AsRef<str> for AxInstrumentState

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for AxInstrumentState

fn clone(&self) -> AxInstrumentState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AxInstrumentState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AxInstrumentState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AxInstrumentState

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

Formats the value using the given formatter.

impl From<AxInstrumentState> for MarketStatusAction

fn from(state: AxInstrumentState) -> Self

Converts to this type from the input type.

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

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 FromStr for AxInstrumentState

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<AxInstrumentState, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for AxInstrumentState

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 AxInstrumentState

type Iterator = AxInstrumentStateIter

fn iter() -> AxInstrumentStateIter

impl<'py> IntoPyObject<'py> for AxInstrumentState

type Target = AxInstrumentState

The Python output type

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

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

const NAME: &str = "AxInstrumentState"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for AxInstrumentState

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 = /// Instrument state as returned by the AX Exchange API. /// /// # References /// - <https://docs.architect.exchange/api-reference/symbols-instruments/get-instruments>

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

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

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

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 PyStubType for AxInstrumentState

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 AxInstrumentState

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 AxInstrumentState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for AxInstrumentState

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from( s: &str, ) -> Result<AxInstrumentState, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for AxInstrumentState

impl Eq for AxInstrumentState

impl StructuralPartialEq for AxInstrumentState