Struct Period 

pub struct Period { /* private fields */ }

A time span expressed as an integer length of a given TimeUnit.

The length may be negative to express a span into the past. Equality and ordering are semantic (12 Months == 1 Year), not structural; see the module docs for the partial-order behaviour.

Implementations

impl Period

pub fn new(n: Integer, units: TimeUnit) -> Period

Builds a period of n units.

pub fn length(&self) -> Integer

The (signed) number of units in the period.

pub fn units(&self) -> TimeUnit

The unit the period is measured in.

pub fn normalize(&mut self)

Rewrites the period into a canonical unit where possible: a zero length becomes Days, a whole number of months collapses to years, and a whole number of days collapses to weeks. Weeks and years are already canonical.

Panics

Panics if the period uses a sub-day unit, which has no place in the calendar algebra (matching QuantLib’s QL_FAIL).

pub fn normalized(&self) -> Period

Returns a normalized copy, leaving self untouched.

pub fn frequency(&self) -> Frequency

The Frequency this period corresponds to, or OtherFrequency when it maps to none of the named ones (e.g. 5 Years). A zero length is Once for years and NoFrequency otherwise.

Panics

Panics if the period uses a sub-day unit (matching QuantLib’s QL_FAIL).

Trait Implementations

impl Add for Period

type Output = Period

The resulting type after applying the + operator.

fn add(self, p: Period) -> Period

Performs the + operation.

impl Add<Period> for Date

type Output = Date

The resulting type after applying the + operator.

fn add(self, p: Period) -> Date

Performs the + operation.

impl AddAssign for Period

fn add_assign(&mut self, p: Period)

Adds p in place, converting units where the algebra allows.

Panics

Panics on an impossible addition, e.g. a non-zero Days period added to a Years one (matching QuantLib’s QL_REQUIRE).

impl Clone for Period

fn clone(&self) -> Period

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Period

impl Debug for Period

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

Formats the value using the given formatter.

impl Default for Period

fn default() -> Period

The empty span, 0 Days (QuantLib’s default-constructed Period).

impl Display for Period

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

Short format, e.g. 2W, 3M, -1Y (QuantLib’s io::short_period).

impl Div<i32> for Period

type Output = Period

The resulting type after applying the / operator.

fn div(self, n: Integer) -> Period

Performs the / operation.

impl DivAssign<i32> for Period

fn div_assign(&mut self, n: Integer)

Divides in place, keeping the original unit when it divides evenly and otherwise falling back to the finer unit (years -> months, weeks -> days).

Panics

Panics if n is zero, or if the period is not divisible by n even after refining the unit (matching QuantLib’s QL_REQUIRE).

impl FromStr for Period

fn from_str(s: &str) -> QlResult<Period>

Parses a period string via parse_period, so "6M".parse::<Period>() works.

type Err = QlError

The associated error which can be returned from parsing.

impl Mul<Period> for Integer

type Output = Period

The resulting type after applying the * operator.

fn mul(self, p: Period) -> Period

Performs the * operation.

impl Mul<i32> for Period

type Output = Period

The resulting type after applying the * operator.

fn mul(self, n: Integer) -> Period

Performs the * operation.

impl MulAssign<i32> for Period

fn mul_assign(&mut self, n: Integer)

Performs the *= operation.

impl Neg for Period

type Output = Period

The resulting type after applying the - operator.

fn neg(self) -> Period

Performs the unary - operation.

impl PartialEq for Period

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

Semantic equality: true only for a decidably-equal pair (an undecidable comparison is not equal).

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

Inequality operator !=.

impl PartialOrd for Period

fn partial_cmp(&self, other: &Period) -> Option<Ordering>

Returns None when the comparison is undecidable (see module docs).

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 Sub for Period

type Output = Period

The resulting type after applying the - operator.

fn sub(self, p: Period) -> Period

Performs the - operation.

impl Sub<Period> for Date

type Output = Date

The resulting type after applying the - operator.

fn sub(self, p: Period) -> Date

Performs the - operation.

impl SubAssign for Period

fn sub_assign(&mut self, p: Period)

Performs the -= operation.

impl TryFrom<Frequency> for Period

fn try_from(f: Frequency) -> QlResult<Period>

Builds the canonical period for a frequency (Annual -> 1 Year, Quarterly -> 3 Months, …).

Errors

Returns an error for OtherFrequency, which names no definite period (matching QuantLib’s QL_FAIL).

type Error = QlError

The type returned in the event of a conversion error.