Struct MonthInterval

pub struct MonthInterval { /* private fields */ }

An interval of months.

Unlike DateInterval, this only represents positive numbers of months, because we never receive this object as a result of subtracting one Date from another; instead, this object’s sole purpose is to create month intervals to add or subtract from dates.

In the event that a month interval is added to a date where the day of the month exceeds the number of days in the result month, the day is set to the final day of the result month. Therefore, adding one month to 2021-01-31 will return 2021-02-28.

Importantly, this means that addition and subtraction are not necessarily communitive.

Example

use date::date;
use date::interval::MonthInterval;

assert_eq!(date! { 2012-04-21 } + MonthInterval::new(3), date! { 2012-07-21 });
assert_eq!(date! { 2021-12-31 } + MonthInterval::new(2), date! { 2022-02-28 });

Implementations

impl MonthInterval

pub const fn new(months: u8) -> Self

Create a new month interval

pub const fn months(&self) -> u8

The number of months this interval represents.

Trait Implementations

impl Add<MonthInterval> for Date

type Output = Date

The resulting type after applying the + operator.

fn add(self, interval: MonthInterval) -> Self

Performs the + operation.

impl Clone for MonthInterval

fn clone(&self) -> MonthInterval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MonthInterval

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

Formats the value using the given formatter.

impl Ord for MonthInterval

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

fn eq(&self, other: &MonthInterval) -> 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 PartialOrd for MonthInterval

fn partial_cmp(&self, other: &MonthInterval) -> 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 Sub<MonthInterval> for Date

type Output = Date

The resulting type after applying the - operator.

fn sub(self, interval: MonthInterval) -> Self

Performs the - operation.

impl Copy for MonthInterval

impl Eq for MonthInterval

impl StructuralPartialEq for MonthInterval