Struct lfest::prelude::Position

pub struct Position<M>
where
    M: Currency + MarginCurrency,
{ /* private fields */ }

Describes the position information of the account. It assumes isolated margining mechanism, because the margin is directly associated with the position.

Implementations

impl<M> Position<M>

where M: Currency + MarginCurrency,

pub fn size(&self) -> M::PairedCurrency

The number of futures contracts making up the position. Denoted in the currency in which the size is valued. e.g.: XBTUSD has a contract size of 1 USD, so M::PairedCurrency is USD.

pub fn entry_price(&self) -> QuoteCurrency

The entry price of the position

pub fn position_margin(&self) -> M

The position margin of account, same denotation as wallet_balance

pub fn leverage(&self) -> Leverage

The position leverage,

impl<M> Position<M>

where M: Currency + MarginCurrency,

pub fn implied_leverage(&self, price: QuoteCurrency) -> Decimal

Returns the implied leverage of the position based on the position value and the collateral backing it. It is computed by dividing the total value of the position by the amount of margin required to hold that position.

pub fn unrealized_pnl(&self, bid: QuoteCurrency, ask: QuoteCurrency) -> M

Return the positions unrealized profit and loss denoted in QUOTE when using linear futures, denoted in BASE when using inverse futures

Trait Implementations

impl<M> Clone for Position<M>

where M: Currency + MarginCurrency + Clone, M::PairedCurrency: Clone,

fn clone(&self) -> Position<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M> Debug for Position<M>

where M: Currency + MarginCurrency + Debug, M::PairedCurrency: Debug,

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

Formats the value using the given formatter.

impl<M> Default for Position<M>

where M: Currency + MarginCurrency + Default, M::PairedCurrency: Default,

fn default() -> Position<M>

Returns the “default value” for a type.

impl<M> PartialEq for Position<M>

where M: Currency + MarginCurrency + PartialEq, M::PairedCurrency: PartialEq,

fn eq(&self, other: &Position<M>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<M> Eq for Position<M>

where M: Currency + MarginCurrency + Eq, M::PairedCurrency: Eq,

impl<M> StructuralPartialEq for Position<M>

where M: Currency + MarginCurrency,