Struct OrderSnapshot

pub struct OrderSnapshot {

    pub trader_id: TraderId,
    pub strategy_id: StrategyId,
    pub instrument_id: InstrumentId,
    pub client_order_id: ClientOrderId,
    pub venue_order_id: Option<VenueOrderId>,
    pub position_id: Option<PositionId>,
    pub account_id: Option<AccountId>,
    pub last_trade_id: Option<TradeId>,
    pub order_type: OrderType,
    pub order_side: OrderSide,
    pub quantity: Quantity,
    pub price: Option<Price>,
    pub trigger_price: Option<Price>,
    pub trigger_type: Option<TriggerType>,
    pub limit_offset: Option<Decimal>,
    pub trailing_offset: Option<Decimal>,
    pub trailing_offset_type: Option<TrailingOffsetType>,
    pub time_in_force: TimeInForce,
    pub expire_time: Option<UnixNanos>,
    pub filled_qty: Quantity,
    pub liquidity_side: Option<LiquiditySide>,
    pub avg_px: Option<f64>,
    pub slippage: Option<f64>,
    pub commissions: Vec<Money>,
    pub status: OrderStatus,
    pub is_post_only: bool,
    pub is_reduce_only: bool,
    pub is_quote_quantity: bool,
    pub display_qty: Option<Quantity>,
    pub emulation_trigger: Option<TriggerType>,
    pub trigger_instrument_id: Option<InstrumentId>,
    pub contingency_type: Option<ContingencyType>,
    pub order_list_id: Option<OrderListId>,
    pub linked_order_ids: Option<Vec<ClientOrderId>>,
    pub parent_order_id: Option<ClientOrderId>,
    pub exec_algorithm_id: Option<ExecAlgorithmId>,
    pub exec_algorithm_params: Option<IndexMap<Ustr, Ustr>>,
    pub exec_spawn_id: Option<ClientOrderId>,
    pub tags: Option<Vec<Ustr>>,
    pub init_id: UUID4,
    pub ts_init: UnixNanos,
    pub ts_last: UnixNanos,
}

Represents an order state snapshot as a certain instant.

Fields

trader_id: TraderId

The trader ID associated with the order.

strategy_id: StrategyId

The strategy ID associated with the order.

instrument_id: InstrumentId

The order instrument ID.

client_order_id: ClientOrderId

The client order ID.

venue_order_id: Option<VenueOrderId>

The venue assigned order ID.

position_id: Option<PositionId>

The position ID associated with the order.

account_id: Option<AccountId>

The account ID associated with the order.

last_trade_id: Option<TradeId>

The orders last trade match ID.

order_type: OrderType

The order type.

order_side: OrderSide

The order side.

quantity: Quantity

The order quantity.

price: Option<Price>

The order price (LIMIT).

trigger_price: Option<Price>

The order trigger price (STOP).

trigger_type: Option<TriggerType>

The trigger type for the order.

limit_offset: Option<Decimal>

The trailing offset for the orders limit price.

trailing_offset: Option<Decimal>

The trailing offset for the orders trigger price (STOP).

trailing_offset_type: Option<TrailingOffsetType>

The trailing offset type.

time_in_force: TimeInForce

The order time in force.

expire_time: Option<UnixNanos>

The order expiration (UNIX epoch nanoseconds), zero for no expiration.

filled_qty: Quantity

The order total filled quantity.

liquidity_side: Option<LiquiditySide>

The order liquidity side.

avg_px: Option<f64>

The order average fill price.

slippage: Option<f64>

The order total price slippage.

commissions: Vec<Money>

The commissions for the order.

status: OrderStatus

The order status.

is_post_only: bool

If the order will only provide liquidity (make a market).

is_reduce_only: bool

If the order carries the ‘reduce-only’ execution instruction.

is_quote_quantity: bool

If the order quantity is denominated in the quote currency.

display_qty: Option<Quantity>

The quantity of the LIMIT order to display on the public book (iceberg).

emulation_trigger: Option<TriggerType>

The order emulation trigger type.

trigger_instrument_id: Option<InstrumentId>

The order emulation trigger instrument ID (will be instrument_id if None).

contingency_type: Option<ContingencyType>

The orders contingency type.

order_list_id: Option<OrderListId>

The order list ID associated with the order.

linked_order_ids: Option<Vec<ClientOrderId>>

The orders linked client order ID(s).

parent_order_id: Option<ClientOrderId>

The parent client order ID.

exec_algorithm_id: Option<ExecAlgorithmId>

The execution algorithm ID for the order.

exec_algorithm_params: Option<IndexMap<Ustr, Ustr>>

The execution algorithm parameters for the order.

exec_spawn_id: Option<ClientOrderId>

The execution algorithm spawning client order ID.

tags: Option<Vec<Ustr>>

The order custom user tags.

init_id: UUID4

The event ID of the OrderInitialized event.

ts_init: UnixNanos

UNIX timestamp (nanoseconds) when the object was initialized.

ts_last: UnixNanos

UNIX timestamp (nanoseconds) when the last event occurred.

Trait Implementations

impl Clone for OrderSnapshot

fn clone(&self) -> OrderSnapshot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrderSnapshot

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OrderSnapshot

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<OrderAny> for OrderSnapshot

fn from(order: OrderAny) -> Self

Converts to this type from the input type.

impl IntoPy<Py<PyAny>> for OrderSnapshot

fn into_py(self, py: Python<'_>) -> PyObject

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

impl<'py> IntoPyObject<'py> for OrderSnapshot

type Target = OrderSnapshot

The Python output type

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

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for OrderSnapshot

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

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<OrderSnapshot>

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<'a, 'py> PyFunctionArgument<'a, 'py> for &'a OrderSnapshot

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

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

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut OrderSnapshot

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

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

impl PyMethods<OrderSnapshot> for PyClassImplCollector<OrderSnapshot>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for OrderSnapshot

const NAME: &'static str = "OrderSnapshot"

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 type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for [PyTypeInfo::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_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for [PyTypeInfo::is_type_of].

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for [PyTypeInfo::is_exact_type_of].

impl Serialize for OrderSnapshot

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for OrderSnapshot

impl HasCustomRichCmp for OrderSnapshot

impl StructuralPartialEq for OrderSnapshot