Enum OrderStatusKind 

pub enum OrderStatusKind {
    ApiPending,
    PendingSubmit,
    PendingCancel,
    PreSubmitted,
    Submitted,
    ApiCancelled,
    Cancelled,
    Filled,
    Inactive,
}

The lifecycle state of an order, as reported by TWS.

See the IB OrderStatus reference.

Default is OrderStatusKind::Submitted to match the Action enum’s pragmatic default; OrderStatus::default callers should overwrite it before reading.

Variants

ApiPending

Order has not yet been sent to the IB server, e.g. while waiting for a security definition lookup. Uncommon in practice.

PendingSubmit

Order has been transmitted to the destination but no acknowledgment has been received yet.

PendingCancel

A cancellation request has been sent but the destination has not yet confirmed it. Cancellation is not guaranteed at this point.

PreSubmitted

A simulated order type has been accepted by the IB system and is held pending its election criteria; once met, it is transmitted to the destination.

Submitted

Order has been accepted by the system and is working at the destination.

ApiCancelled

API client requested cancellation after submission but before acknowledgment, producing this transitional state.

Cancelled

Destination has confirmed the order is fully cancelled. Terminal. May also occur if IB or the destination unexpectedly rejects the order.

Filled

Order has been completely filled. Terminal. (Market orders may not always trigger this state.)

Inactive

Order was received but is no longer active because it was rejected or cancelled. Terminal.

Implementations

impl OrderStatusKind

pub fn as_str(&self) -> &'static str

Return the canonical wire string for this status.

pub fn is_active(self) -> bool

Order is still working in the market: PreSubmitted, PendingSubmit, PendingCancel, Submitted.

Note that is_active and is_terminal together cover 8 of 9 variants — ApiPending is neither, so do not assume !is_active() ⇒ is_terminal().

pub fn is_terminal(self) -> bool

Order has reached a final state: Filled, Cancelled, ApiCancelled, Inactive.

Trait Implementations

impl Clone for OrderStatusKind

fn clone(&self) -> OrderStatusKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for OrderStatusKind

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for OrderStatusKind

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

Formats the value using the given formatter.

impl Default for OrderStatusKind

fn default() -> OrderStatusKind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OrderStatusKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OrderStatusKind

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

Formats the value using the given formatter.

impl FromStr for OrderStatusKind

type Err = Error

The associated error which can be returned from parsing.

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

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

impl PartialEq for OrderStatusKind

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for OrderStatusKind

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl Copy for OrderStatusKind

impl Eq for OrderStatusKind

impl StructuralPartialEq for OrderStatusKind