Struct PeriodicMarginInterest 

pub struct PeriodicMarginInterest { /* private fields */ }

Margin interest charged a period at a time, at an annualised rate per asset: a crypto margin account’s hourly interest.

• When. One period when a loan is taken, whenever in the period that is, then one at every boundary while the loan is open, unless InterestSchedule::AtBorrowOnly. Boundaries fall at whole multiples of the period since the Unix epoch, so an hourly period charges on the hour, UTC. Each charge pays in advance for the period it falls in: the one a borrow is taken in, or the one a boundary begins. So a loan repaid mid-period has already paid for that period, and one repaid just before a boundary is not charged there.
• How much. principal × rate × period / basis, where the rate is annualised, read from the asset’s RateSeries at the instant charged, and the basis is the DayCount’s year. Each charge is rounded up to the asset’s unit, 1e-8 unless set by with_unit, so a small loan is charged at least one unit, as a venue that books interest in whole units charges it.
• Which assets. Only those given rates. A loan of any other asset, or one charged before its series begins, is charged nothing.

A venue that quotes a daily rate is reproduced by an annual rate of daily × 365 on DayCount::Act365.

Implementations

impl PeriodicMarginInterest

pub fn new(period: TimeDelta, day_count: DayCount) -> Self

Interest charged every period on the day_count basis, at borrow and each boundary, with no asset’s rates yet.

Panics

If period is not positive.

pub fn with_rates(self, asset: AssetNameExchange, rates: RateSeries) -> Self

Charges a loan of asset at the annualised rates in rates.

Panics

If any rate in rates is negative: a borrower is never paid interest, so a negative rate is a fault in the data, refused here rather than when the venue first charges it.

pub fn with_unit(self, asset: AssetNameExchange, unit: Decimal) -> Self

Rounds each charge on asset up to a multiple of unit instead of 1e-8.

Panics

If unit is not positive.

pub fn with_schedule(self, schedule: InterestSchedule) -> Self

Charges on schedule instead of at borrow and each boundary.

Trait Implementations

impl Clone for PeriodicMarginInterest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PeriodicMarginInterest

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

Formats the value using the given formatter.

impl MarginInterestModel for PeriodicMarginInterest

fn next_boundary( &self, asset: &AssetNameExchange, after: DateTime<Utc>, ) -> Option<DateTime<Utc>>

The first boundary strictly after after at which this model charges a loan of asset, or None if it never does.

fn charge( &self, asset: &AssetNameExchange, principal: Decimal, due: InterestDue, ) -> Option<InterestCharge>

What a loan of principal of asset is charged when due, or None for nothing.