Enum finance_solution::TvmVariable

pub enum TvmVariable {
    Rate,
    Periods,
    PresentValue,
    FutureValue,
}

Enumeration used for the calculated_field field in TvmSolution and [TvmSchedule] to keep track of what was calculated, either the periodic rate, the number of periods, the present value, or the future value.

Variants

Rate

Periods

PresentValue

FutureValue

Implementations

impl TvmVariable

pub fn is_rate(&self) -> bool

Returns true if the variant is TvmVariable::Rate indicating that the periodic rate was calculated from the number of periods, the present value, and the future value.

pub fn is_periods(&self) -> bool

Returns true if the variant is TvmVariable::Periods indicating that the number of periods was calculated from the periocic rate, the present value, and the future value.

pub fn is_present_value(&self) -> bool

Returns true if the variant is TvmVariable::PresentValue indicating that the present value was calculated from one or more periocic rates, the number of periods, and the future value.

pub fn is_future_value(&self) -> bool

Returns true if the variant is TvmVariable::FutureValue indicating that the future value was calculated from one or more periocic rates, the number of periods, and the present value.

Trait Implementations

impl Clone for TvmVariable

fn clone(&self) -> TvmVariable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TvmVariable

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

Formats the value using the given formatter.

impl Display for TvmVariable

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

Formats the value using the given formatter.

impl Eq for TvmVariable

impl Hash for TvmVariable

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<TvmVariable> for TvmVariable

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralPartialEq for TvmVariable