Enum OrderStatus 

#[repr(C)]
pub enum OrderStatus {
    Initialized = 1,
    Denied = 2,
    Emulated = 3,
    Released = 4,
    Submitted = 5,
    Accepted = 6,
    Rejected = 7,
    Canceled = 8,
    Expired = 9,
    Triggered = 10,
    PendingUpdate = 11,
    PendingCancel = 12,
    PartiallyFilled = 13,
    Filled = 14,
}

The status for a specific order.

An order is considered open for the following status:

• ACCEPTED
• TRIGGERED
• PENDING_UPDATE
• PENDING_CANCEL
• PARTIALLY_FILLED

An order is considered in-flight for the following status:

• SUBMITTED
• PENDING_UPDATE
• PENDING_CANCEL

An order is considered closed for the following status:

• DENIED
• REJECTED
• CANCELED
• EXPIRED
• FILLED

Variants

Initialized = 1

The order is initialized (instantiated) within the Nautilus system.

Denied = 2

The order was denied by the Nautilus system, either for being invalid, unprocessable or exceeding a risk limit.

Emulated = 3

The order became emulated by the Nautilus system in the OrderEmulator component.

Released = 4

The order was released by the Nautilus system from the OrderEmulator component.

Submitted = 5

The order was submitted by the Nautilus system to the external service or trading venue (awaiting acknowledgement).

Accepted = 6

The order was acknowledged by the trading venue as being received and valid (may now be working).

Rejected = 7

The order was rejected by the trading venue.

Canceled = 8

The order was canceled (closed/done).

Expired = 9

The order reached a GTD expiration (closed/done).

Triggered = 10

The order STOP price was triggered on a trading venue.

PendingUpdate = 11

The order is currently pending a request to modify on a trading venue.

PendingCancel = 12

The order is currently pending a request to cancel on a trading venue.

PartiallyFilled = 13

The order has been partially filled on a trading venue.

Filled = 14

The order has been completely filled on a trading venue (closed/done).

Implementations

impl OrderStatus

pub const fn from_repr(discriminant: usize) -> Option<OrderStatus>

Try to create Self from the raw representation

impl OrderStatus

pub const fn is_open(self) -> bool

Returns whether the order status represents an open/working order.

pub const fn is_closed(self) -> bool

Returns whether the order status represents a terminal (closed) state.

pub const fn is_cancellable(self) -> bool

Returns whether the order can be cancelled from this status.

pub fn cancellable_statuses_set() -> &'static AHashSet<Self>

Returns a cached AHashSet of order statuses safe for cancellation queries.

These are statuses where an order is working on the venue but not already in the process of being cancelled or updated. Including PENDING_CANCEL in cancellation filters can cause duplicate cancel attempts or incorrect open order counts.

Returns:

• ACCEPTED: Order is working on the venue.
• TRIGGERED: Stop order has been triggered.
• PENDING_UPDATE: Order being updated.
• PARTIALLY_FILLED: Order is partially filled but still working.

Excludes:

• PENDING_CANCEL: Already being cancelled.

impl OrderStatus

pub fn transition(&mut self, event: &OrderEventAny) -> Result<Self, OrderError>

Transitions the order state machine based on the given event.

Errors

Returns an error if the state transition is invalid from the current status.

impl OrderStatus

pub fn name(&self) -> String

pub fn value(&self) -> u8

Trait Implementations

impl AsRef<str> for OrderStatus

fn as_ref(&self) -> &str

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

impl Clone for OrderStatus

fn clone(&self) -> OrderStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OrderStatus

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OrderStatus

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

Formats the value using the given formatter.

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

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 OrderStatus

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for OrderStatus

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 OrderStatus

type Iterator = OrderStatusIter

fn iter() -> OrderStatusIter

impl<'py> IntoPyObject<'py> for OrderStatus

type Target = OrderStatus

The Python output type

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

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

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

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

const NAME: &str = "OrderStatus"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for OrderStatus

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 = /// The status for a specific order. /// /// An order is considered _open_ for the following status: /// - `ACCEPTED` /// - `TRIGGERED` /// - `PENDING_UPDATE` /// - `PENDING_CANCEL` /// - `PARTIALLY_FILLED` /// /// An order is considered _in-flight_ for the following status: /// - `SUBMITTED` /// - `PENDING_UPDATE` /// - `PENDING_CANCEL` /// /// An order is considered _closed_ for the following status: /// - `DENIED` /// - `REJECTED` /// - `CANCELED` /// - `EXPIRED` /// - `FILLED`

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

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

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 PyClassNewTextSignature for OrderStatus

const TEXT_SIGNATURE: &'static str = "(value)"

impl PyStubType for OrderStatus

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 OrderStatus

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 OrderStatus

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 OrderStatus

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for OrderStatus

impl Eq for OrderStatus

impl StructuralPartialEq for OrderStatus