pub struct SignedLeverageToNotional(/* private fields */);
Expand description

Leverage calculated based on the protocol’s internal representation.

This is calculated by comparing the notional size of a position against some amount of collateral (either active collateral from the trader or counter collateral from the liquidity pool). One of these values needs to be converted using a Price, so the leverage will change over time based on exchange rate.

Implementations§

§

impl SignedLeverageToNotional

pub fn direction(self) -> DirectionToNotional

Extract the direction value

pub fn calculate( notional_size: Signed<Notional>, price_point: &PricePoint, collateral: NonZero<Collateral> ) -> SignedLeverageToNotional

Calculate based on notional size, a price point, and some amount of collateral.

Can fail because of overflow issues, but is otherwise guaranteed to return a sensible value since the collateral is a non-zero value.

pub fn into_number(self) -> Signed<Decimal256>

Convert into the raw value.

pub fn into_base( self, market_type: MarketType ) -> Result<SignedLeverageToBase, Error>

Convert into an SignedLeverageToBase.

pub fn checked_mul_collateral( self, collateral: NonZero<Collateral> ) -> Result<Signed<Collateral>, Error>

Multiply by active collateral of a position, returning the notional size in collateral of a position.

Trait Implementations§

§

impl Clone for SignedLeverageToNotional

§

fn clone(&self) -> SignedLeverageToNotional

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for SignedLeverageToNotional

§

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

Formats the value using the given formatter. Read more
§

impl From<Signed<Decimal256>> for SignedLeverageToNotional

§

fn from(value: Signed<Decimal256>) -> SignedLeverageToNotional

Converts to this type from the input type.
§

impl Copy for SignedLeverageToNotional

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<U> As for U

§

fn as_<T>(self) -> Twhere T: CastFrom<U>,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for Twhere T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.