Struct Month 

pub struct Month { /* private fields */ }

A calendar month. As a valuation date it means the end of that month.

use prospicio_core::Month;

let m = Month::new(2021, 11).unwrap();
assert_eq!(m.add_months(3), Month::new(2022, 2).unwrap());
assert_eq!(m.to_string(), "2021-11");

Implementations

impl Month

pub fn new(year: i32, month: u8) -> Result<Self>

The month month (1 to 12) of year.

pub const fn january(year: i32) -> Self

January of year.

pub const fn year(self) -> i32

Calendar year.

pub const fn month(self) -> u8

Month of the year, 1 to 12.

pub fn add_months(self, n: i64) -> Self

The month n months later (earlier if n is negative).

pub const fn months_since(self, earlier: Month) -> i64

Whole months from earlier to self (negative if self is earlier).

pub fn floor(self, grain: Grain) -> Self

First month of the grain period containing self. Periods are aligned to the calendar year: quarters start in January, April, July and October.

Trait Implementations

impl Clone for Month

fn clone(&self) -> Month

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Month

impl Debug for Month

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

Formats the value using the given formatter.

impl Display for Month

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

Formats the value using the given formatter.

impl Eq for Month

impl Hash for Month

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 Month

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Month

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