Struct Periods 

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

Count of compounding / payment periods (u32).

Implementations

impl Periods

pub fn new(value: u32) -> FinanceResult<Self>

Any period count (including zero where formulas allow).

pub fn at_least_one(value: u32) -> FinanceResult<Self>

At least one period (annuities, many TA windows expressed as u32).

pub fn get(self) -> u32

Trait Implementations

impl Clone for Periods

fn clone(&self) -> Periods

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Periods

impl Debug for Periods

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

Formats the value using the given formatter.

impl Display for Periods

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

Formats the value using the given formatter.

impl Eq for Periods

impl From<Periods> for u32

fn from(p: Periods) -> u32

Converts to this type from the input type.

impl Hash for Periods

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 Ord for Periods

fn cmp(&self, other: &Periods) -> 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 Periods

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Periods

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

impl TryFrom<u32> for Periods

type Error = FinanceError

The type returned in the event of a conversion error.

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

Performs the conversion.