Enum PaymentTiming 

pub enum PaymentTiming {
    EndOfPeriod,
    BeginningOfPeriod,
}

When a level payment (annuity installment) falls within each period.

Prefer this enum over a bare bool. For ergonomics, false converts to PaymentTiming::EndOfPeriod and true to PaymentTiming::BeginningOfPeriod (Excel type=0 / type=1).

Examples

use finance_solution::{payment, PaymentTiming};

let end = payment(0.01, 12, 1_000.0, 0.0, PaymentTiming::EndOfPeriod).unwrap();
let end_bool = payment(0.01, 12, 1_000.0, 0.0, false).unwrap();
assert!((end - end_bool).abs() < 1e-12);

let due = payment(0.01, 12, 1_000.0, 0.0, true).unwrap();
assert!(due.abs() < end.abs()); // due payments are slightly smaller in magnitude

Variants

EndOfPeriod

Payment at the end of each period (ordinary annuity). Default / Excel type=0.

BeginningOfPeriod

Payment at the beginning of each period (annuity due). Excel type=1.

Implementations

impl PaymentTiming

pub fn is_beginning(&self) -> bool

True when payments fall at the start of each period.

pub fn is_end(&self) -> bool

True when payments fall at the end of each period.

Trait Implementations

impl Clone for PaymentTiming

fn clone(&self) -> PaymentTiming

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PaymentTiming

impl Debug for PaymentTiming

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

Formats the value using the given formatter.

impl Default for PaymentTiming

fn default() -> PaymentTiming

Returns the “default value” for a type.

impl Display for PaymentTiming

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

Formats the value using the given formatter.

impl Eq for PaymentTiming

impl From<PaymentTiming> for bool

fn from(timing: PaymentTiming) -> bool

Converts to this type from the input type.

impl From<bool> for PaymentTiming

fn from(due_at_beginning: bool) -> Self

Converts to this type from the input type.

impl Hash for PaymentTiming

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 PartialEq for PaymentTiming

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PaymentTiming