Struct PositionRef 

pub struct PositionRef<'a>(/* private fields */);

Lifetime-scoped read borrow of a cached position.

Returned by crate::cache::Cache::position. The borrow drops with the enclosing scope, which makes any attempt to hold it across a cache mutation panic at runtime: a loud failure beats the silent staleness that a stored clone would produce.

Method calls on the inner Position resolve via Deref; comparisons against &Position or owned Position values are direct (position_ref == &position); Display and Debug forward to the inner record. Use cloned when an owned snapshot is required (for example, before crossing a boundary that may dispatch events).

Implementations

impl<'a> PositionRef<'a>

pub fn new(inner: Ref<'a, Position>) -> Self

Wraps the given Ref borrow.

pub fn cloned(&self) -> Position

Returns an owned snapshot of the borrowed position.

Mirrors Option::cloned and Iterator::cloned; the snapshot will not reflect later mutations of the underlying cell.

Methods from Deref<Target = Position>

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 total_pnl(&self, last: Price) -> Money

Returns total P&L (realized + unrealized) based on the last price.

pub fn unrealized_pnl(&self, last: Price) -> Money

Returns unrealized P&L based on the last price.

pub fn closing_order_side(&self) -> OrderSide

Returns the order side required to close this position.

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

Returns the instrument symbol.

pub fn venue(&self) -> Venue

Returns the trading venue.

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>

Returns unique client order IDs from all fill events, sorted.

pub fn venue_order_ids(&self) -> Vec<VenueOrderId>

Returns unique venue order IDs from all fill events, sorted.

pub fn trade_ids(&self) -> Vec<TradeId>

Returns unique trade IDs from all fill events, sorted.

pub fn notional_value(&self, last: Price) -> Money

Calculates the notional value based on the last price.

Panics

Panics if self.base_currency is None, or if last is not a positive price for inverse instruments.

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>

Returns the last TradeId for the position (if any after purging).

pub fn is_long(&self) -> bool

Returns whether the position is long (positive quantity).

pub fn is_short(&self) -> bool

Returns whether the position is short (negative quantity).

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

Returns whether the position is closed (flat with a close timestamp).

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>

Returns the cumulative commissions for the position as a vector.

Trait Implementations

impl AsRef<Position> for PositionRef<'_>

fn as_ref(&self) -> &Position

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for PositionRef<'_>

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

Formats the value using the given formatter.

impl Deref for PositionRef<'_>

type Target = Position

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for PositionRef<'_>

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

Formats the value using the given formatter.

impl<'a> From<Ref<'a, Position>> for PositionRef<'a>

fn from(inner: Ref<'a, Position>) -> Self

Converts to this type from the input type.

impl PartialEq<&Position> for PositionRef<'_>

fn eq(&self, other: &&Position) -> 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 PartialEq<Position> for PositionRef<'_>

fn eq(&self, other: &Position) -> 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 PartialEq for PositionRef<'_>

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.