Struct Balance 

pub struct Balance {
    pub symbol: String,
    pub quantity: Positive,
    pub average_premium: Positive,
    pub current_premium: Option<Positive>,
    pub exchange: String,
    pub underlying_asset_type: UnderlyingAssetType,
    pub margin_info: Option<MarginInfo>,
}

Represents the balance of a specific option position in an exchange.

This struct encapsulates all the information needed to track an option position, including quantity, premium information, and profit/loss calculations. This balance is specifically designed for options trading.

Fields

symbol: String

Symbol or Epic of the option contract

quantity: Positive

Quantity of option contracts held

average_premium: Positive

Average premium at which the option was acquired

current_premium: Option<Positive>

Current market premium of the option (if available)

exchange: String

Name of the exchange where the option is held

underlying_asset_type: UnderlyingAssetType

Type of underlying asset (e.g., Stock, Forex, Index)

margin_info: Option<MarginInfo>

Margin information for accounts that support leverage

Implementations

impl Balance

pub fn new( symbol: String, quantity: Positive, average_premium: Positive, current_premium: Option<Positive>, exchange: String, underlying_asset_type: UnderlyingAssetType, margin_info: Option<MarginInfo>, ) -> Self

Creates a new Balance instance for an option position.

Arguments

• symbol - The option contract symbol (e.g., “AAPL240315C00150000”)
• quantity - The quantity of option contracts held
• average_premium - The average premium paid for the option
• current_premium - The current market premium (optional)
• exchange - The name of the exchange
• underlying_asset_type - The type of the underlying asset
• margin_info - Margin information for accounts that support leverage (optional)

Returns

A new Balance instance for the option position

pub fn get_total_value(&self) -> Result<Positive, PositiveError>

Calculates the total value of the option position based on current premium.

Returns

The total value (quantity * current_premium) if current_premium is available, otherwise returns the cost basis (quantity * average_premium). The product is formed in Decimal, with no f64 step.

Errors

Returns PositiveError::ArithmeticError when the product overflows Decimal.

pub fn get_unrealized_pnl(&self) -> Result<Decimal, DecimalError>

Calculates the unrealized profit or loss of the position.

Returns

The unrealized PnL as a Decimal. Positive values indicate profit, negative values indicate loss. Returns zero if current_price is not available.

Errors

Returns DecimalError::Overflow when the current value or the cost basis leaves the Decimal range; the multiplication aborted with Multiplication overflowed (#788).

pub fn update_current_premium(&mut self, new_premium: Positive)

Updates the current market premium of the option.

Arguments

• new_premium - The new current market premium

pub fn is_profitable(&self) -> Result<bool, DecimalError>

Checks if the position is currently profitable.

Returns

true if the position has unrealized gains, false otherwise. Returns false if current_price is not available.

Errors

Propagates the error of Balance::get_unrealized_pnl.

pub fn get_cost_basis(&self) -> Result<Positive, PositiveError>

Gets the cost basis of the option position.

Returns

The total cost basis (quantity * average_premium), formed in Decimal with no f64 step.

Errors

Returns PositiveError::ArithmeticError when the product overflows Decimal.

pub fn get_percentage_return(&self) -> Result<Decimal, DecimalError>

Gets the percentage return of the position.

Returns

The percentage return as a Decimal. Returns zero if current_price is not available, and zero for a zero cost basis, where no return is defined.

Errors

Returns DecimalError::Overflow when the cost basis, the ratio of the P&L to it, or its scaling to a percentage overflows Decimal.

Trait Implementations

impl Clone for Balance

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for Balance

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for Balance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Balance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Balance

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

Formats the value using the given formatter.

impl PartialEq for Balance

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Balance

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 Balance

impl ToSchema for Balance

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.