Struct OrderStatus 

pub struct OrderStatus {
    pub order_id: i32,
    pub status: OrderStatusKind,
    pub filled: f64,
    pub remaining: f64,
    pub average_fill_price: Option<f64>,
    pub perm_id: i64,
    pub parent_id: i32,
    pub last_fill_price: Option<f64>,
    pub client_id: i32,
    pub why_held: String,
    pub market_cap_price: Option<f64>,
}

Contains all relevant information on the current status of the order execution-wise (i.e. amount filled and pending, filling price, etc.).

Fields

order_id: i32

The order’s client id.

status: OrderStatusKind

The current status of the order. See OrderStatusKind for variant definitions and helpers like is_terminal.

filled: f64

Number of filled positions.

remaining: f64

The remnant positions.

average_fill_price: Option<f64>

Average filling price. None when IBKR did not send a value (UNSET_DOUBLE on text protocol; missing optional field on protobuf).

perm_id: i64

The order’s permId used by the TWS to identify orders.

parent_id: i32

Parent’s id. Used for bracket and auto trailing stop orders.

last_fill_price: Option<f64>

Price at which the last positions were filled. None when IBKR did not send a value.

client_id: i32

API client which submitted the order.

why_held: String

This field is used to identify an order held when TWS is trying to locate shares for a short sell. The value used to indicate this is ‘locate’.

market_cap_price: Option<f64>

If an order has been capped, this indicates the current capped price. Requires TWS 967+ and API v973.04+. Python API specifically requires API v973.06+. None when IBKR did not send a value.

Implementations

impl OrderStatus

pub fn outcome(&self) -> Option<OrderOutcome>

How the order ended, or None while it is still working (partial fills included). The rule wait_for_fill applies to each status, for waits built on order_status_stream.

Filled for status Filled, or nothing remaining after a fill (market orders do not always report Filled); Ended for any other terminal status.

Examples

use ibapi::orders::{OrderOutcome, OrderStatus, OrderStatusKind};

let partial = OrderStatus { status: OrderStatusKind::Submitted, filled: 40.0, remaining: 60.0, ..Default::default() };
assert_eq!(partial.outcome(), None);

let done = OrderStatus { filled: 100.0, remaining: 0.0, ..partial };
assert!(matches!(done.outcome(), Some(OrderOutcome::Filled(_))));

Trait Implementations

impl Clone for OrderStatus

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for OrderStatus

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

impl Debug for OrderStatus

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

Formats the value using the given formatter.

impl Default for OrderStatus

fn default() -> Self

Returns the “default value” for a type.

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

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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

impl ToSchema for OrderStatus

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.