Struct OrderList 

pub struct OrderList {
    pub id: OrderListId,
    pub instrument_id: InstrumentId,
    pub strategy_id: StrategyId,
    pub client_order_ids: Vec<ClientOrderId>,
    pub ts_init: UnixNanos,
}

Lightweight identifier container for a group of related orders.

Stores only the order IDs; full order data lives in the cache. For serialization payload, see SubmitOrderList.order_inits.

All orders should share the same venue. The production constructors enforce this: OrderList::from_orders and OrderFactory::create_list panic on mixed venues, and Strategy::submit_order_list bails at the user-facing entry. OrderList::new is infallible and takes instrument_id directly; it does not verify the venues of the supplied client_order_ids. The instrument_id is a representative value taken from the first order; orders may target different instruments at that venue. Downstream consumers that need a per-order instrument should resolve each order from the cache.

Fields

id: OrderListId

instrument_id: InstrumentId

strategy_id: StrategyId

client_order_ids: Vec<ClientOrderId>

ts_init: UnixNanos

Implementations

impl OrderList

pub fn new( order_list_id: OrderListId, instrument_id: InstrumentId, strategy_id: StrategyId, client_order_ids: Vec<ClientOrderId>, ts_init: UnixNanos, ) -> Self

Creates a new OrderList instance.

Construction is infallible. OrderList::validate checks the syntactic invariants (non-empty, unique client_order_ids); the strategy submission path (Strategy::submit_order_list) runs it before the list reaches the cache.

pub fn from_orders(orders: &[OrderAny], ts_init: UnixNanos) -> Self

Creates a new OrderList from a slice of orders.

Derives order_list_id, instrument_id, and strategy_id from the first order. The instrument_id is representative only; orders in the list may target different instruments at the same venue. Callers in the production path (OrderFactory plus a single strategy instance) produce orders with a consistent order_list_id and strategy_id. OrderList::validate checks the syntactic invariants (non-empty, unique client_order_ids); it does not check cross-field consistency.

Panics

Panics if orders is empty, if the first order has no order_list_id, or if orders span more than one venue. Callers are expected to guard non-empty input; Strategy::submit_order_list filters out the empty case and bails on mixed venues before reaching this constructor.

pub fn validate(&self) -> Result<(), OrderListValidationError>

Validates this OrderList’s own invariants.

Errors

Returns an error if client_order_ids is empty or contains duplicates.

pub fn first(&self) -> Option<&ClientOrderId>

pub fn len(&self) -> usize

Returns the number of orders in the list.

pub fn is_empty(&self) -> bool

Returns true if the list contains no orders.

Trait Implementations

impl Clone for OrderList

fn clone(&self) -> OrderList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderList

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

Formats the value using the given formatter.

impl DerefToPyAny for OrderList

impl<'de> Deserialize<'de> for OrderList

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OrderList

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

Formats the value using the given formatter.

impl Eq for OrderList

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

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 Hash for OrderList

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<'py> IntoPyObject<'py> for OrderList

type Target = OrderList

The Python output type

type Output = Bound<'py, <OrderList 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 OrderList

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

const NAME: &str = "OrderList"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for OrderList

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 = /// Lightweight identifier container for a group of related orders. /// /// Stores only the order IDs; full order data lives in the cache. /// For serialization payload, see `SubmitOrderList.order_inits`. /// /// All orders should share the same venue. The production constructors /// enforce this: [`OrderList::from_orders`] and `OrderFactory::create_list` /// panic on mixed venues, and `Strategy::submit_order_list` bails at the /// user-facing entry. [`OrderList::new`] is infallible and takes /// `instrument_id` directly; it does not verify the venues of the supplied /// `client_order_ids`. The `instrument_id` is a representative value taken /// from the first order; orders may target different instruments at that /// venue. Downstream consumers that need a per-order instrument should /// resolve each order from the cache.

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

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

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 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 PyTypeInfo for OrderList

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 OrderList

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

where __S: Serializer,

Serialize this value into the given Serde serializer.