Trait PositionState 

pub trait PositionState<const DECIMALS: u8> {
    type Num: MulDiv<Signed = Self::Signed> + FixedPointOps<DECIMALS>;
    type Signed: UnsignedAbs<Unsigned = Self::Num> + TryFrom<Self::Num> + Num;

    // Required methods
    fn collateral_amount(&self) -> &Self::Num;
    fn size_in_usd(&self) -> &Self::Num;
    fn size_in_tokens(&self) -> &Self::Num;
    fn borrowing_factor(&self) -> &Self::Num;
    fn funding_fee_amount_per_size(&self) -> &Self::Num;
    fn claimable_funding_fee_amount_per_size(
        &self,
        is_long_collateral: bool,
    ) -> &Self::Num;
}

Read-only access to the position state.

Required Associated Types

type Num: MulDiv<Signed = Self::Signed> + FixedPointOps<DECIMALS>

Unsigned number type.

type Signed: UnsignedAbs<Unsigned = Self::Num> + TryFrom<Self::Num> + Num

Signed number type.

Required Methods

fn collateral_amount(&self) -> &Self::Num

Get the collateral amount.

fn size_in_usd(&self) -> &Self::Num

Get a reference to the size (in USD) of the position.

fn size_in_tokens(&self) -> &Self::Num

Get a reference to the size (in tokens) of the position.

fn borrowing_factor(&self) -> &Self::Num

Get a reference to last borrowing factor applied by the position.

fn funding_fee_amount_per_size(&self) -> &Self::Num

Get a reference to the funding fee amount per size.

fn claimable_funding_fee_amount_per_size( &self, is_long_collateral: bool, ) -> &Self::Num

Get a reference to claimable funding fee amount per size of the given collateral.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl<const DECIMALS: u8, P: PositionState<DECIMALS>> PositionState<DECIMALS> for &mut P

type Num = <P as PositionState<DECIMALS>>::Num

type Signed = <P as PositionState<DECIMALS>>::Signed

fn collateral_amount(&self) -> &Self::Num

fn size_in_usd(&self) -> &Self::Num

fn size_in_tokens(&self) -> &Self::Num

fn borrowing_factor(&self) -> &Self::Num

fn funding_fee_amount_per_size(&self) -> &Self::Num

fn claimable_funding_fee_amount_per_size( &self, is_long_collateral: bool, ) -> &Self::Num

Implementors

impl<T, const DECIMALS: u8> PositionState<DECIMALS> for TestPositionOps<'_, T, DECIMALS>

where T: CheckedSub + Display + FixedPointOps<DECIMALS>, T::Signed: Num + Debug,

Available on crate features test only.

type Num = T

type Signed = <T as Unsigned>::Signed