Struct BaseCurrency

pub struct BaseCurrency(/* private fields */);

The markets BASE currency, e.g.: BTCUSD -> BTC is the BASE currency

Trait Implementations

impl Add<Decimal> for BaseCurrency

Arithmetic with Decimal on the right hand side

type Output = BaseCurrency

The resulting type after applying the + operator.

fn add(self, rhs: Decimal) -> Self::Output

Performs the + operation.

impl Add for BaseCurrency

type Output = BaseCurrency

The resulting type after applying the + operator.

fn add(self, rhs: BaseCurrency) -> BaseCurrency

Performs the + operation.

impl AddAssign for BaseCurrency

fn add_assign(&mut self, rhs: BaseCurrency)

Performs the += operation.

impl AsRef<Decimal> for BaseCurrency

fn as_ref(&self) -> &Decimal

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for BaseCurrency

fn clone(&self) -> BaseCurrency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Currency for BaseCurrency

type PairedCurrency = QuoteCurrency

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

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.

fn new_zero() -> Self

Create a new currency instance with zero value

fn is_zero(&self) -> bool

Check if the value is zero

fn abs(self) -> Self

TODO: it may be smart to remove this here and use another type that can be negative Get the absolute value

fn convert(&self, rate: QuoteCurrency) -> Self::PairedCurrency

Convert this Currency’s value into its pair at the conversion rate. E.g: 1 BTC @ 20_000 USD means that 1 USD = 1 / 20_000 BTC

fn into_negative(self) -> Self

Convert the Currency to a negative value TODO: rename for greater clarity

fn quantize(self, val: Self) -> Self

Quantize the currency value.

impl Debug for BaseCurrency

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

Formats the value using the given formatter.

impl Default for BaseCurrency

fn default() -> BaseCurrency

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BaseCurrency

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BaseCurrency

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

Formats the value using the given formatter.

impl Div<Decimal> for BaseCurrency

type Output = BaseCurrency

The resulting type after applying the / operator.

fn div(self, rhs: Decimal) -> Self::Output

Performs the / operation.

impl Div<Leverage> for BaseCurrency

type Output = BaseCurrency

The resulting type after applying the / operator.

fn div(self, rhs: Leverage) -> Self::Output

Performs the / operation.

impl Div for BaseCurrency

type Output = BaseCurrency

The resulting type after applying the / operator.

fn div(self, rhs: BaseCurrency) -> BaseCurrency

Performs the / operation.

impl From<BaseCurrency> for Decimal

fn from(value: BaseCurrency) -> Self

Converts to this type from the input type.

impl From<Decimal> for BaseCurrency

fn from(value: Decimal) -> Self

Converts to this type from the input type.

impl Hash for BaseCurrency

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl MarginCurrency for BaseCurrency

fn pnl<S: Currency>( entry_price: QuoteCurrency, exit_price: QuoteCurrency, quantity: S, ) -> S::PairedCurrency

This represents the pnl calculation for inverse futures contracts

fn price_paid_for_qty( &self, quantity: <Self as Currency>::PairedCurrency, ) -> QuoteCurrency

Compute the price paid for self (total_cost) for quantity number of contracts.

impl Mul<Decimal> for BaseCurrency

type Output = BaseCurrency

The resulting type after applying the * operator.

fn mul(self, rhs: Decimal) -> Self::Output

Performs the * operation.

impl<MakerTaker> Mul<Fee<MakerTaker>> for BaseCurrency

type Output = BaseCurrency

The resulting type after applying the * operator.

fn mul(self, rhs: Fee<MakerTaker>) -> Self::Output

Performs the * operation.

impl Mul for BaseCurrency

type Output = BaseCurrency

The resulting type after applying the * operator.

fn mul(self, rhs: BaseCurrency) -> BaseCurrency

Performs the * operation.

impl Ord for BaseCurrency

fn cmp(&self, other: &BaseCurrency) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BaseCurrency

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for BaseCurrency

fn partial_cmp(&self, other: &BaseCurrency) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Rem for BaseCurrency

type Output = BaseCurrency

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl Serialize for BaseCurrency

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Decimal> for BaseCurrency

type Output = BaseCurrency

The resulting type after applying the - operator.

fn sub(self, rhs: Decimal) -> Self::Output

Performs the - operation.

impl Sub for BaseCurrency

type Output = BaseCurrency

The resulting type after applying the - operator.

fn sub(self, rhs: BaseCurrency) -> BaseCurrency

Performs the - operation.

impl SubAssign for BaseCurrency

fn sub_assign(&mut self, rhs: BaseCurrency)

Performs the -= operation.

impl Copy for BaseCurrency

impl Eq for BaseCurrency

impl StructuralPartialEq for BaseCurrency