Struct Rate 

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

Periodic or continuous interest / return rate as a decimal (e.g. 0.05 = 5%).

Domain depends on constructor: Rate::tvm (≥ -1), Rate::payment (> -1), Rate::positive (> 0), Rate::finite (any finite).

Implementations

impl Rate

pub fn finite(value: f64) -> FinanceResult<Self>

Any finite rate (no lower bound). Prefer domain-specific constructors for TVM.

pub fn tvm(value: f64) -> FinanceResult<Self>

TVM-compatible rate: finite and ≥ -1.0.

pub fn payment(value: f64) -> FinanceResult<Self>

Payment / annuity rate: finite and > -1.0.

pub fn positive(value: f64) -> FinanceResult<Self>

Strictly positive finite rate (doubling rules, growth rates).

pub fn get(self) -> f64

Inner f64 (by value; type is Copy).

Trait Implementations

impl Clone for Rate

fn clone(&self) -> Rate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Rate

impl Debug for Rate

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

Formats the value using the given formatter.

impl Display for Rate

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

Formats the value using the given formatter.

impl From<Rate> for f64

fn from(r: Rate) -> f64

Converts to this type from the input type.

impl PartialEq for Rate

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Rate

fn partial_cmp(&self, other: &Rate) -> 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 StructuralPartialEq for Rate

impl TryFrom<f64> for Rate

fn try_from(value: f64) -> Result<Self, Self::Error>

Defaults to Rate::tvm (most common finance domain).

type Error = FinanceError

The type returned in the event of a conversion error.