Struct Position 

pub struct Position { /* private fields */ }

Represents a position (holding) in the portfolio.

Implementations

impl Position

pub fn new( symbol: impl Into<String>, exchange: impl Into<String>, quantity: Decimal, current_price: Money, ) -> Self

Creates a new Position.

pub fn builder( symbol: impl Into<String>, exchange: impl Into<String>, ) -> PositionBuilder

Creates a Position builder for more complex construction.

pub fn symbol(&self) -> &str

Returns the symbol.

pub fn exchange(&self) -> &str

Returns the exchange.

pub fn instrument_id(&self) -> Option<&str>

Returns the instrument ID if set.

pub const fn quantity(&self) -> Decimal

Returns the quantity held.

pub const fn lot_size(&self) -> u32

Returns the lot size.

pub const fn current_price(&self) -> &Money

Returns the current price.

pub const fn average_cost(&self) -> Option<&Money>

Returns the average cost if set.

pub const fn is_blocked(&self) -> bool

Returns whether the position is blocked.

pub const fn blocked_lots(&self) -> u32

Returns the number of blocked lots.

pub fn market_value(&self) -> Money

Calculates the total market value of the position.

pub fn lots_held(&self) -> u32

Calculates the number of complete lots held.

pub fn tradeable_lots(&self) -> u32

Calculates the number of tradeable lots (total - blocked).

pub fn unrealized_pnl(&self) -> Option<Money>

Calculates the unrealized P&L if average cost is known.

pub fn unrealized_pnl_percent(&self) -> Option<Decimal>

Calculates the unrealized P&L percentage if average cost is known.

pub fn update_price(&mut self, price: Money)

Updates the current price.

pub fn update_quantity(&mut self, quantity: Decimal)

Updates the quantity.

Trait Implementations

impl Clone for Position

fn clone(&self) -> Self

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 PartialEq for Position

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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.

impl StructuralPartialEq for Position