Enum Frequency 

pub enum Frequency {
    Annual,
    SemiAnnual,
    Quarterly,
    BiMonthly,
    Monthly,
    Weekly,
    Daily,
    Weeks(u16),
    Days(u16),
    Once,
}

Payment / accrual frequency.

FpML has no FrequencyEnum; it models frequency as a Period (calculationPeriodFrequency). Frequency is an ergonomic, Period-derived convenience with total conversions to and from Period.

Variants

Annual

Once per year (12M).

SemiAnnual

Twice per year (6M).

Quarterly

Four times per year (3M).

BiMonthly

Six times per year (2M).

Monthly

Twelve times per year (1M).

Weekly

Weekly (1W).

Daily

Daily (1D).

Weeks(u16)

Every n weeks ("4W"), n ≥ 2 — 28-day-coupon markets (MXN F-TIIE) step by exact multi-week periods. Parsing never produces Weeks(1) (that is Frequency::Weekly).

Days(u16)

Every n calendar days ("28D"), n ≥ 2. Parsing never produces Days(1) (that is Frequency::Daily).

Once

A single payment at maturity (zero-coupon / bullet legs). Has no recurring period; consumers MUST branch on this variant rather than stepping by Frequency::to_period.

Implementations

impl Frequency

pub fn to_period(self) -> Period

The Period this frequency corresponds to.

pub fn periods_per_year(self) -> f64

The number of compounding periods per year this frequency implies (Annual → 1, SemiAnnual → 2, Quarterly → 4, BiMonthly → 6, Monthly → 12, Weekly → 52, Daily → 365). Used as the f in periodic compounding.

pub fn from_period(period: Period) -> Option<Self>

The named frequency matching period, if one exists. A 1Y period maps to Frequency::Annual.

impl Frequency

pub fn code(self) -> String

The FpML-consistent code — the period form ("12M", "3M", …). FpML has no FrequencyEnum; frequency is a Period.

impl Frequency

pub const ACCEPTED: &'static [&'static str]

Every spelling this vocabulary accepts, canonical forms first.

pub(crate) fn recognize(s: &str) -> Option<Self>

The value s spells, or None — the parse without its error, so probing a spelling that is not this vocabulary’s allocates nothing.

Trait Implementations

impl Clone for Frequency

fn clone(&self) -> Frequency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Frequency

impl Debug for Frequency

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

Formats the value using the given formatter.

impl Eq for Frequency

impl FromStr for Frequency

type Err = VocabularyParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Frequency

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 Frequency

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Frequency