Trait lfest::prelude::Currency

source ·

pub trait Currency: Copy + Default + Send + Sized + Ord + Debug + Display + Add<Output = Self> + Sub<Output = Self> + Mul<Output = Self> + Div<Output = Self> + Rem<Output = Self> + Add<Decimal, Output = Self> + Sub<Decimal, Output = Self> + Mul<Decimal, Output = Self> + Div<Decimal, Output = Self> + Div<Leverage, Output = Self> + Mul<Fee, Output = Self> + Add<Fee, Output = Self> + AddAssign + SubAssign + PartialEq + PartialOrd {
    type PairedCurrency: Currency<PairedCurrency = Self>;

    // Required methods
    fn new(val: Decimal) -> Self;
    fn inner(self) -> Decimal;
    fn new_zero() -> Self;
    fn is_zero(&self) -> bool;
    fn abs(self) -> Self;
    fn fee_portion(&self, fee: Fee) -> Self;
    fn convert(&self, rate: QuoteCurrency) -> Self::PairedCurrency;
    fn into_negative(self) -> Self;
}

Expand description

Every unit of account must implement this trait

Required Associated Types§

source

type PairedCurrency: Currency<PairedCurrency = Self>

The paired currency. e.g.: for the BTCUSD market the BTC currency is paired with USD, so the PairedCurrency would be USD

Required Methods§

source

fn new(val: Decimal) -> Self

Create a new instance from a Rational value TODO: change return type to be Result<Self>, beacuse inputting a Decimal that it LTE zero could happen.

source