Struct timext::CalendarDuration

pub struct CalendarDuration { /* private fields */ }

TODO Represent fraction of week with opt f32 see https://github.com/xwde/timext/issues/6

let d0 = Date::from_calendar_date(2023, Month::January, 31).unwrap();
let d1 = Date::from_calendar_date(2023, Month::February, 28).unwrap();
assert_eq!(d0 + 1.months(), d1);

let d0 = Date::from_calendar_date(2024, Month::February, 29).unwrap();
let d1 = Date::from_calendar_date(2025, Month::February, 28).unwrap();///
assert_eq!(d0 + 1.years(), d1);

Implementations

impl CalendarDuration

pub const fn new(years: i32, months: i32) -> Self

Creates a new CalendarDuration with provided years and months.

let d0 = CalendarDuration::new(2, 24);
assert_eq!(d0.whole_years(), 4);
assert_eq!(d0.whole_months(), 48);

pub const fn years(years: i32) -> Self

Creates a new CalendarDuration with provided years.

let d0 = CalendarDuration::years(2);
assert_eq!(d0.whole_years(), 2);
assert_eq!(d0.whole_months(), 24);

pub const fn months(months: i32) -> Self

Creates a new CalendarDuration with provided months.

let d0 = CalendarDuration::months(24);
assert_eq!(d0.whole_years(), 2);
assert_eq!(d0.whole_months(), 24);

pub const MIN: Self = _

pub const MAX: Self = _

impl CalendarDuration

pub const fn whole_years(self) -> i32

Returns the number of whole years in the CalendarDuration.

assert_eq!(1.years().whole_years(), 1);
assert_eq!((-1).years().whole_years(), -1);
assert_eq!(6.months().whole_years(), 0);
assert_eq!((-6).months().whole_years(), 0);

pub const fn whole_months(self) -> i32

Returns the number of whole months in the CalendarDuration.

assert_eq!(1.months().whole_months(), 1);
assert_eq!((-1).months().whole_months(), -1);
assert_eq!(6.months().whole_years(), 0);
assert_eq!((-6).months().whole_years(), 0);

pub const fn subyear_months(self) -> i32

Returns the number of months past the number of whole years.

assert_eq!(13.months().subyear_months(), 1);
assert_eq!((-13).months().subyear_months(), -1);

pub const fn is_zero(self) -> bool

Checks if a duration is negative.

assert!(0.months().is_zero());
assert!(!1.months().is_zero());

pub const fn is_positive(self) -> bool

Checks if a CalendarDuration is positive.

assert!(1.months().is_positive());
assert!(!0.months().is_positive());
assert!(!(-1).months().is_positive());

pub const fn is_negative(self) -> bool

Checks if a CalendarDuration is negative.

assert!((-1).months().is_negative());
assert!(!0.months().is_negative());
assert!(!1.months().is_negative());

impl CalendarDuration

pub const fn abs(self) -> Self

Returns the absolute value of the duration.

assert_eq!(1.months().abs(), 1.months());
assert_eq!(0.months().abs(), 0.months());
assert_eq!((-1).months().abs(), 1.months());

impl CalendarDuration

pub fn checked_date_add(date: Date, duration: Self) -> Option<Date>

Returns the sum of provided Date and CalendarDuration.

let d0 = Date::from_calendar_date(2018, September, 1).unwrap();
let d1 = Date::from_calendar_date(2018, October, 1).unwrap();
let rs = CalendarDuration::checked_date_add(d0, 1.months());
assert_eq!(rs.unwrap(), d1);

pub fn checked_date_sub(date: Date, duration: Self) -> Option<Date>

Returns the difference of provided Date and CalendarDuration.

let d0 = Date::from_calendar_date(2018, September, 1).unwrap();
let d1 = Date::from_calendar_date(2018, August, 1).unwrap();
let rs = CalendarDuration::checked_date_sub(d0, 1.months());
assert_eq!(rs.unwrap(), d1);

impl CalendarDuration

pub fn checked_add(self, rhs: Self) -> Option<Self>

Computes self + rhs, returning None if an overflow occurred.

assert_eq!(5.months().checked_add(5.months()), Some(10.months()));
assert_eq!(CalendarDuration::MAX.checked_add(1.months()), None);
assert_eq!((-5).months().checked_add(5.months()), Some(0.months()));

pub fn checked_sub(self, rhs: Self) -> Option<Self>

Computes self - rhs, returning None if an overflow occurred.

assert_eq!(5.months().checked_sub(5.months()), Some(0.months()));
assert_eq!(CalendarDuration::MIN.checked_sub(1.months()), None);
assert_eq!(5.months().checked_sub(5.months()), Some(0.months()));

pub fn checked_mul(self, rhs: i32) -> Option<Self>

Computes self * rhs, returning None if an overflow occurred.

assert_eq!(5.months().checked_mul(2), Some(10.months()));
assert_eq!(5.months().checked_mul(-2), Some((-10).months()));
assert_eq!(5.months().checked_mul(0), Some(0.months()));
assert_eq!(CalendarDuration::MAX.checked_mul(2), None);
assert_eq!(CalendarDuration::MIN.checked_mul(2), None);

pub fn checked_div(self, rhs: i32) -> Option<Self>

Computes self / rhs, returning None if rhs == 0 or if the result would overflow.

assert_eq!(10.months().checked_div(2), Some(5.months()));
assert_eq!(10.months().checked_div(-2), Some((-5).months()));
assert_eq!(1.months().checked_div(0), None);

pub fn checked_neg(self) -> Option<Self>

Computes -self, returning None if an overflow occurred.

assert_eq!(10.months().checked_neg(), Some((-10).months()));
assert_eq!(CalendarDuration::MIN.checked_neg(), None);

Trait Implementations

impl Add<CalendarDuration> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Add<CalendarDuration> for Date

type Output = Date

The resulting type after applying the + operator.

fn add(self, rhs: CalendarDuration) -> Self::Output

Performs the + operation.

impl Add<CalendarDuration> for PrimitiveDateTime

type Output = PrimitiveDateTime

The resulting type after applying the + operator.

fn add(self, rhs: CalendarDuration) -> Self::Output

Performs the + operation.

impl AddAssign<CalendarDuration> for CalendarDuration

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AddAssign<CalendarDuration> for Date

fn add_assign(&mut self, rhs: CalendarDuration)

Performs the += operation.

impl AddAssign<CalendarDuration> for PrimitiveDateTime

fn add_assign(&mut self, rhs: CalendarDuration)

Performs the += operation.

impl Clone for CalendarDuration

fn clone(&self) -> CalendarDuration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CalendarDuration

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

Formats the value using the given formatter.

impl Default for CalendarDuration

fn default() -> CalendarDuration

Returns the “default value” for a type.

impl Display for CalendarDuration

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

Formats the value using the given formatter.

impl Div<i16> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the / operator.

fn div(self, rhs: i16) -> Self::Output

Performs the / operation.

impl Div<i32> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the / operator.

fn div(self, rhs: i32) -> Self::Output

Performs the / operation.

impl Div<i8> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the / operator.

fn div(self, rhs: i8) -> Self::Output

Performs the / operation.

impl Div<u16> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the / operator.

fn div(self, rhs: u16) -> Self::Output

Performs the / operation.

impl Div<u32> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Self::Output

Performs the / operation.

impl Div<u8> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the / operator.

fn div(self, rhs: u8) -> Self::Output

Performs the / operation.

impl DivAssign<i16> for CalendarDuration

fn div_assign(&mut self, rhs: i16)

Performs the /= operation.

impl DivAssign<i32> for CalendarDuration

fn div_assign(&mut self, rhs: i32)

Performs the /= operation.

impl DivAssign<i8> for CalendarDuration

fn div_assign(&mut self, rhs: i8)

Performs the /= operation.

impl DivAssign<u16> for CalendarDuration

fn div_assign(&mut self, rhs: u16)

Performs the /= operation.

impl DivAssign<u32> for CalendarDuration

fn div_assign(&mut self, rhs: u32)

Performs the /= operation.

impl DivAssign<u8> for CalendarDuration

fn div_assign(&mut self, rhs: u8)

Performs the /= operation.

impl Hash for CalendarDuration

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 Mul<CalendarDuration> for i16

type Output = CalendarDuration

The resulting type after applying the * operator.

fn mul(self, rhs: CalendarDuration) -> Self::Output

Performs the * operation.

impl Mul<CalendarDuration> for i32

type Output = CalendarDuration

The resulting type after applying the * operator.

fn mul(self, rhs: CalendarDuration) -> Self::Output

Performs the * operation.

impl Mul<CalendarDuration> for i8

type Output = CalendarDuration

The resulting type after applying the * operator.

fn mul(self, rhs: CalendarDuration) -> Self::Output

Performs the * operation.

impl Mul<CalendarDuration> for u16

type Output = CalendarDuration

The resulting type after applying the * operator.

fn mul(self, rhs: CalendarDuration) -> Self::Output

Performs the * operation.

impl Mul<CalendarDuration> for u32

type Output = CalendarDuration

The resulting type after applying the * operator.

fn mul(self, rhs: CalendarDuration) -> Self::Output

Performs the * operation.

impl Mul<CalendarDuration> for u8

type Output = CalendarDuration

The resulting type after applying the * operator.

fn mul(self, rhs: CalendarDuration) -> Self::Output

Performs the * operation.

impl Mul<i16> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the * operator.

fn mul(self, rhs: i16) -> Self::Output

Performs the * operation.

impl Mul<i32> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> Self::Output

Performs the * operation.

impl Mul<i8> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the * operator.

fn mul(self, rhs: i8) -> Self::Output

Performs the * operation.

impl Mul<u16> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the * operator.

fn mul(self, rhs: u16) -> Self::Output

Performs the * operation.

impl Mul<u32> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> Self::Output

Performs the * operation.

impl Mul<u8> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the * operator.

fn mul(self, rhs: u8) -> Self::Output

Performs the * operation.

impl MulAssign<i16> for CalendarDuration

fn mul_assign(&mut self, rhs: i16)

Performs the *= operation.

impl MulAssign<i32> for CalendarDuration

fn mul_assign(&mut self, rhs: i32)

Performs the *= operation.

impl MulAssign<i8> for CalendarDuration

fn mul_assign(&mut self, rhs: i8)

Performs the *= operation.

impl MulAssign<u16> for CalendarDuration

fn mul_assign(&mut self, rhs: u16)

Performs the *= operation.

impl MulAssign<u32> for CalendarDuration

fn mul_assign(&mut self, rhs: u32)

Performs the *= operation.

impl MulAssign<u8> for CalendarDuration

fn mul_assign(&mut self, rhs: u8)

Performs the *= operation.

impl Neg for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for CalendarDuration

fn cmp(&self, other: &CalendarDuration) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<CalendarDuration> for CalendarDuration

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<CalendarDuration> for CalendarDuration

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<CalendarDuration> for CalendarDuration

type Output = CalendarDuration

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Sub<CalendarDuration> for Date

type Output = Date

The resulting type after applying the - operator.

fn sub(self, rhs: CalendarDuration) -> Self::Output

Performs the - operation.

impl Sub<CalendarDuration> for PrimitiveDateTime

type Output = PrimitiveDateTime

The resulting type after applying the - operator.

fn sub(self, rhs: CalendarDuration) -> Self::Output

Performs the - operation.

impl SubAssign<CalendarDuration> for CalendarDuration

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl SubAssign<CalendarDuration> for Date

fn sub_assign(&mut self, rhs: CalendarDuration)

Performs the -= operation.

impl SubAssign<CalendarDuration> for PrimitiveDateTime

fn sub_assign(&mut self, rhs: CalendarDuration)

Performs the -= operation.

impl Copy for CalendarDuration

impl Eq for CalendarDuration

impl StructuralEq for CalendarDuration

impl StructuralPartialEq for CalendarDuration