pub struct PositionRefMut<'a>(/* private fields */);Expand description
Lifetime-scoped exclusive write borrow of a cached position.
Returned by crate::cache::Cache::position_mut. While the borrow is alive, no other read or
write on the same cell is permitted (enforced at runtime by the underlying RefMut).
Drop the borrow before dispatching events or taking any other cache borrow that may re-enter
the same position.
Implementations§
Methods from Deref<Target = Position>§
pub fn clone_without_events(&self) -> Position
pub fn clone_without_events(&self) -> Position
Returns a copy without stored events, adjustments, replay events, fill voids, or trade IDs.
§Warning
Use this copy only as transient read state. Applying events or caching this copy can bypass replay and duplicate-fill checks and discard position history.
pub fn purge_events_for_order(&mut self, client_order_id: ClientOrderId)
pub fn purge_events_for_order(&mut self, client_order_id: ClientOrderId)
Purges all order fill events for the given client order ID and recalculates derived state.
§Warning
This operation recalculates the entire position from scratch after removing the specified order’s fills. This is an expensive operation and should be used sparingly.
§Panics
Panics if after purging, no fills remain and the position cannot be reconstructed.
pub fn apply(&mut self, fill: &OrderFilled)
pub fn apply(&mut self, fill: &OrderFilled)
Applies an OrderFilled event to this position.
§Panics
Panics if the fill.trade_id is already present in the position’s trade_ids.
pub fn try_apply(&mut self, fill: &OrderFilled) -> Result<(), CorrectnessError>
pub fn try_apply(&mut self, fill: &OrderFilled) -> Result<(), CorrectnessError>
Applies an OrderFilled event to this position with correctness checking.
§Errors
Returns an error if the fill instrument or position identity does not match this position, the fill has no position ID, or an ordinary duplicate trade ID is applied. An error leaves the position unchanged.
pub fn apply_adjustment(&mut self, adjustment: PositionAdjusted)
pub fn apply_adjustment(&mut self, adjustment: PositionAdjusted)
Applies a position adjustment event.
This method handles adjustments to position quantity or realized PnL that occur outside of normal order fills, such as:
- Commission adjustments in base currency (crypto spot markets).
- Funding payments (perpetual futures).
The adjustment event is stored in the position’s adjustment history for full audit trail.
§Panics
Panics if the adjustment’s quantity_change cannot be converted to f64.
pub fn apply_fill_void(
&mut self,
event: OrderFillVoided,
voided_qty: Quantity,
commission_voided: Option<Money>,
) -> Result<Option<Money>, Error>
pub fn apply_fill_void( &mut self, event: OrderFillVoided, voided_qty: Quantity, commission_voided: Option<Money>, ) -> Result<Option<Money>, Error>
Applies a cumulative fill correction allocated to this position and rebuilds derived state.
Returns the realized PnL of the cycles the rebuild closed before the current one, which
[Self::realized_pnl] no longer holds because reopening from flat resets it. A caller
archiving closed cycles needs this to keep their PnL once the correction has moved the
cycle boundaries its existing archive describes. None when the corrected history never
goes flat, so the current cycle covers all of it.
§Errors
Returns an error when the allocation is stale, duplicated, or exceeds known fragments.
pub fn fill_fragments(
&self,
client_order_id: ClientOrderId,
trade_id: TradeId,
) -> Vec<&OrderFilled>
pub fn fill_fragments( &self, client_order_id: ClientOrderId, trade_id: TradeId, ) -> Vec<&OrderFilled>
Returns durable fill fragments matching an order trade in local application order.
pub fn try_calculate_pnl(
&self,
avg_px_open: f64,
avg_px_close: f64,
quantity: Quantity,
) -> Result<Money, Error>
pub fn try_calculate_pnl( &self, avg_px_open: f64, avg_px_close: f64, quantity: Quantity, ) -> Result<Money, Error>
Calculates profit and loss from the given prices and quantity.
§Errors
Returns an error if inverse P&L cannot be calculated or the result cannot be represented as
[Money].
pub fn calculate_pnl(
&self,
avg_px_open: f64,
avg_px_close: f64,
quantity: Quantity,
) -> Money
pub fn calculate_pnl( &self, avg_px_open: f64, avg_px_close: f64, quantity: Quantity, ) -> Money
Calculates profit and loss from the given prices and quantity.
pub fn try_total_pnl(&self, last: Price) -> Result<Money, Error>
pub fn try_total_pnl(&self, last: Price) -> Result<Money, Error>
Returns total P&L (realized + unrealized) based on the last price.
§Errors
Returns an error if unrealized P&L cannot be calculated, the realized and unrealized
currencies differ, or the total cannot be represented as [Money].
pub fn total_pnl(&self, last: Price) -> Money
pub fn total_pnl(&self, last: Price) -> Money
Returns total P&L (realized + unrealized) based on the last price.
pub fn try_unrealized_pnl(&self, last: Price) -> Result<Money, Error>
pub fn try_unrealized_pnl(&self, last: Price) -> Result<Money, Error>
Returns unrealized P&L based on the last price.
§Errors
Returns an error if inverse P&L cannot be calculated or the result cannot be represented as
[Money].
pub fn unrealized_pnl(&self, last: Price) -> Money
pub fn unrealized_pnl(&self, last: Price) -> Money
Returns unrealized P&L based on the last price.
pub fn closing_order_side(&self) -> Option<OrderSide>
pub fn closing_order_side(&self) -> Option<OrderSide>
Returns the order side required to close this position.
pub fn is_opposite_side(&self, side: OrderSide) -> bool
pub fn is_opposite_side(&self, side: OrderSide) -> bool
Returns whether the given order side is opposite to the position entry side.
pub fn symbol(&self) -> Symbol
pub fn symbol(&self) -> Symbol
Returns the instrument symbol.
pub fn venue(&self) -> Venue
pub fn venue(&self) -> Venue
Returns the trading venue.
pub fn event_count(&self) -> usize
pub fn event_count(&self) -> usize
Returns the count of order fill events applied to this position.
pub fn client_order_ids(&self) -> Vec<ClientOrderId>
pub fn client_order_ids(&self) -> Vec<ClientOrderId>
Returns unique client order IDs from all fill events, sorted.
pub fn venue_order_ids(&self) -> Vec<VenueOrderId>
pub fn venue_order_ids(&self) -> Vec<VenueOrderId>
Returns unique venue order IDs from all fill events, sorted.
pub fn try_notional_value(&self, last: Price) -> Result<Money, Error>
pub fn try_notional_value(&self, last: Price) -> Result<Money, Error>
Calculates the notional value based on the last price.
§Errors
Returns an error if this is an inverse position without a base currency, the price is not
positive for inverse valuation, or the result cannot be represented as [Money].
pub fn notional_value(&self, last: Price) -> Money
pub fn notional_value(&self, last: Price) -> Money
Calculates the notional value based on the last price.
§Panics
Panics if [Position::try_notional_value] returns an error.
pub fn last_event(&self) -> Option<OrderFilled>
pub fn last_event(&self) -> Option<OrderFilled>
Returns the last OrderFilled event for the position (if any after purging).
pub fn last_trade_id(&self) -> Option<TradeId>
pub fn last_trade_id(&self) -> Option<TradeId>
Returns the last TradeId for the position (if any after purging).
pub fn is_open(&self) -> bool
pub fn is_open(&self) -> bool
Returns whether the position is currently open (has quantity and no close timestamp).
pub fn is_closed(&self) -> bool
pub fn is_closed(&self) -> bool
Returns whether the position is closed (flat with a close timestamp).
pub fn signed_decimal_qty(&self) -> Decimal
pub fn signed_decimal_qty(&self) -> Decimal
Returns the signed quantity as a Decimal.
Uses the raw signed_qty field to preserve full precision, as the quantity
field may have reduced precision based on the instrument’s size_precision.
pub fn commissions(&self) -> Vec<Money>
pub fn commissions(&self) -> Vec<Money>
Returns the cumulative commissions for the position as a vector.