Struct Position 

pub struct Position {
    pub position: PositionDetails,
    pub market: PositionMarket,
    pub pnl: Option<f64>,
}

Individual position

Fields

position: PositionDetails

Details of the position

market: PositionMarket

Market information for the position

pnl: Option<f64>

Profit and loss for the position

Implementations

impl Position

pub fn pnl(&self) -> f64

Calculates the profit and loss (PnL) for the current position of a trader.

The method determines PnL based on whether it is already cached (self.pnl) or needs to be calculated from the position and market details.

Returns

A floating-point value that represents the PnL for the position. Positive values indicate a profit, and negative values indicate a loss.

Logic

• If self.pnl is set, the cached value is returned directly.
• Otherwise it delegates to Position::pnl_checked, which marks a Buy against market.bid and a Sell against market.offer. When the direction’s market price is unavailable there is no basis for a P&L, so this returns 0.0 (use Position::pnl_checked to distinguish the unknown case as None).

pub fn pnl_checked(&self) -> Option<f64>

Computes P&L from current market prices, or None when the required price for the position’s direction is unavailable.

This is the single source of truth for position P&L: a Buy is marked against market.bid, a Sell against market.offer, as (price - level) * size (sign flipped for a Sell). When that price is missing there is no basis for a P&L, so this returns None rather than fabricating a value — callers that need a number use pnl(), which treats the unknown case as 0.0. Unlike the pre-pnl() field override, this ignores any cached self.pnl.

Returns

Some(pnl) when the direction’s market price is present, else None.

pub fn update_pnl(&mut self)

Updates the cached profit and loss (PnL) for the current position from current market prices.

Delegates to Position::pnl_checked (a Buy marked against market.bid, a Sell against market.offer) and stores the result in self.pnl. When the direction’s market price is unavailable there is no basis for a P&L, so 0.0 is stored.

Fields Updated

• self.pnl: set to Some(pnl), or Some(0.0) when the required market price is missing.

impl Position

pub fn is_call(&self) -> bool

Checks if the current financial instrument is a call option.

A call option is a financial derivative that gives the holder the right (but not the obligation) to buy an underlying asset at a specified price within a specified time period. This method checks whether the instrument represented by this instance is a call option by inspecting the instrument_name field.

Returns

• true if the instrument’s name contains the substring "CALL", indicating it is a call option.
• false otherwise.

pub fn is_put(&self) -> bool

Checks if the financial instrument is a “PUT” option.

This method examines the instrument_name field of the struct to determine if it contains the substring “PUT”. If the substring is found, the method returns true, indicating that the instrument is categorized as a “PUT” option. Otherwise, it returns false.

Returns

• true - If instrument_name contains the substring “PUT”.
• false - If instrument_name does not contain the substring “PUT”.

Trait Implementations

impl Add for Position

fn add(self, other: Position) -> Position

Adds two positions together.

Invariants

Both positions must belong to the same market (same EPIC). In debug builds, adding positions from different markets will panic. In release builds, the left-hand side market is used.

type Output = Position

The resulting type after applying the + operator.

impl Clone for Position

fn clone(&self) -> Position

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Position

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Position

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

Formats the value using the given formatter.

impl Serialize for Position

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

where __S: Serializer,

Serialize this value into the given Serde serializer.