Struct options_common::SharesPosition

pub struct SharesPosition {
    pub symbol: String,
    pub is_long: bool,
    pub unit_cost: Option<Rational64>,
    pub unit_bid_price: Option<Rational64>,
    pub unit_ask_price: Option<Rational64>,
    pub quantity: Rational64,
}

Fields

symbol: String

The symbol of the stock.

is_long: bool

Whether the position is long or short the underlying.

unit_cost: Option<Rational64>

The original cost per share in this position. If the position is long, this should be negative.

unit_bid_price: Option<Rational64>

The current bid price per share in this position. If the position is long, this should be positive.

unit_ask_price: Option<Rational64>

The current ask price per share in this position. If the position is long, this should be positive.

quantity: Rational64

The number of shares in this position.

Trait Implementations

impl Clone for SharesPosition

fn clone(&self) -> SharesPosition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SharesPosition

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

Formats the value using the given formatter.

impl From<SharesPosition> for Position

fn from(v: SharesPosition) -> Position

Converts to this type from the input type.

impl GenericPosition for SharesPosition

fn symbol(&self) -> &str

For an option position, the symbol of the option itself. For a share position, equal to Self::underlying_symbol().

fn underlying_symbol(&self) -> &str

For an option position, the symbol of the instrument that the option is a derivative of. For a share position, the symbol of the stock.

fn is_long(&self) -> bool

Whether the position is long or short the underlying.

fn unit_cost(&self) -> Option<Rational64>

The original cost per option contract or share in this position. If the position is long, this should be negative.

fn unit_cost_mut(&mut self) -> &mut Option<Rational64>

fn unit_bid_price(&self) -> Option<Rational64>

The current bid price per option contract or share in this position. If the position is long, this should be positive.

fn unit_bid_price_mut(&mut self) -> &mut Option<Rational64>

fn unit_ask_price(&self) -> Option<Rational64>

The current ask price per option contract or share in this position. If the position is long, this should be positive.

fn unit_ask_price_mut(&mut self) -> &mut Option<Rational64>

fn unit_delta(&self) -> Option<NotNan<f64>>

The delta per option contract or share in this position, where the delta equivalent of 1 share == 0.01.

fn unit_vega(&self) -> Option<NotNan<f64>>

The vega per option contract or share in this position.

fn unit_theta(&self) -> Option<NotNan<f64>>

The theta per option contract in this position.

fn quantity(&self) -> Rational64

The number of option contracts or shares in this position.

fn quantity_mut(&mut self) -> &mut Rational64

fn equivalent_strike_price(&self) -> Rational64

For an option position, the strike price of the option. For a share position, the strike price of the call option with the equivalent cost at the time of purchase i.e. $0.

fn equivalent_option_type(&self) -> OptionType

For an option position, the type of the option. For a share position, equal to OptionType::Call.

fn equivalent_lot_size(&self) -> i64

For an option position, the number of units of the underlying per option contract. For a share position, equal to 1.

fn signed_quantity(&self) -> Rational64

Equal to Self::quantity(), but negative if the position is short.

fn cost(&self) -> Option<Rational64>

The total original cost of all option contracts or shares in this position.

fn net_liq(&self) -> Option<Rational64>

fn bid_price(&self) -> Option<Rational64>

The total current bid price for all option contracts or shares in this position.

fn ask_price(&self) -> Option<Rational64>

The total current ask price for all option contracts or shares in this position.

fn mid_price(&self) -> Option<Rational64>

The total current mid price for all option contracts or shares in this position.

fn unit_mid_price(&self) -> Option<Rational64>

The current mid price per option contract or share in this position. If the position is long, this will be positive.

fn delta(&self) -> Option<NotNan<f64>>

The total delta for all option contracts or shares in this position, where the delta equivalent of 1 share == 0.01.

fn vega(&self) -> Option<NotNan<f64>>

The total vega for all option contracts or shares in this position.

fn theta(&self) -> Option<NotNan<f64>>

The total theta for all option contracts or shares in this position.

fn profit_at_expiry(&self, underlying_price: Rational64) -> Rational64

impl PartialEq<SharesPosition> for SharesPosition

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl TryInto<SharesPosition> for Position

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<SharesPosition, <Self as TryInto<SharesPosition>>::Error>

Performs the conversion.

impl Eq for SharesPosition

impl StructuralEq for SharesPosition

impl StructuralPartialEq for SharesPosition