Struct PreTradeLock 

#[non_exhaustive]
pub struct PreTradeLock { /* private fields */ }

Stable lock context captured during pre-trade reservation.

PreTradeLock is not just a copy of request input. It is the serialized context of what the engine actually reserved and how that reservation must later be reconciled.

Policies may need to persist data that is known at reservation time but will also be required later, when execution reports arrive and the engine must release, consume, or re-price the remaining reserved state correctly. Typical examples include the reservation price, translated quantities, or any other policy-specific values that describe how funds were locked.

The lock context must travel together with the order lifecycle. If a policy relies on execution report fill details to reconcile the reservation, the lock produced during pre-trade must be stored until the final execution report for that order has been processed. Dropping it too early breaks the engine’s ability to correctly unlock the unused remainder or finalize the reserved state using the same assumptions that were applied when the order was accepted.

A common case is price-sensitive reservation. The engine may reserve funds using a worst execution price known during pre-trade. Later, when partial fills and the final terminal report arrive, that same price must still be available to compute how much reserved amount remains to be released. Without the stored lock context, post-trade reconciliation would need to guess, which is not a valid contract for deterministic risk handling.

In other words, PreTradeLock is the continuation token of reservation logic. It captures the policy context that must survive from pre-trade acceptance to the last execution report relevant for that reservation.

This crate exposes Serde compatibility only when the serde feature is enabled. Applications embedding openpit choose the concrete transport format themselves.

JSON is the canonical format for external bindings. Binary transports such as MessagePack and CBOR are selected by the consuming application. Bincode remains Rust-only and is outside the cross-language compatibility contract.

Implementations

impl PreTradeLock

pub fn new(price: Option<Price>) -> Self

Creates a new lock context captured during reservation.

pub fn price(&self) -> Option<Price>

Returns the reservation price stored in the lock context.

This value is typically used later during execution-report processing to reconcile reserved versus actually used amounts.

Trait Implementations

impl Clone for PreTradeLock

fn clone(&self) -> PreTradeLock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PreTradeLock

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

Formats the value using the given formatter.

impl Default for PreTradeLock

fn default() -> PreTradeLock

Returns the “default value” for a type.

impl PartialEq for PreTradeLock

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

impl Eq for PreTradeLock

impl StructuralPartialEq for PreTradeLock