add MonthsDelta

Author: esheppa

src/lib.rs

@@ -419,6 +419,8 @@ pub mod prelude {
     #[doc(no_inline)]
     pub use crate::Locale;
     #[doc(no_inline)]
+    pub use crate::MonthsDelta;
+    #[doc(no_inline)]
     pub use crate::SubsecRound;
     #[doc(no_inline)]
     pub use crate::{DateTime, SecondsFormat};
@@ -466,7 +468,7 @@ mod weekday;
 pub use weekday::{ParseWeekdayError, Weekday};
 
 mod month;
-pub use month::{Month, Months, ParseMonthError};
+pub use month::{Month, Months, MonthsDelta, ParseMonthError};
 
 mod traits;
 pub use traits::{Datelike, Timelike};

src/month.rs

@@ -176,7 +176,7 @@ impl TryFrom<u8> for Month {
 }
 
 /// A duration in calendar months
-#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd)]
+#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
 pub struct Months(pub(crate) u32);
 
 impl Months {
@@ -186,6 +186,66 @@ impl Months {
     }
 }
 
+/// A difference in a number of months, either forwards or backwards.
+///
+/// This type is often returned from fuctions but is generally not used as a parameter.
+/// Instead the inner `Months` must first be extracted and then used. There are helper methods
+/// which can assist with this.
+#[derive(Clone, Copy, Debug, PartialOrd, Ord)]
+pub enum MonthsDelta {
+    /// the forwards direction
+    Forwards(Months),
+    /// the backwards direction
+    Backwards(Months),
+}
+
+impl MonthsDelta {
+    /// Assert that the direction is forwards and throw away the `Months` otherwise.
+    pub fn forwards(self) -> Option<Months> {
+        match self {
+            MonthsDelta::Forwards(d) => Some(d),
+            MonthsDelta::Backwards(_) => None,
+        }
+    }
+
+    /// Assert that the direction is backwards and throw away the `Months` otherwise.
+    pub fn backwards(self) -> Option<Months> {
+        match self {
+            MonthsDelta::Forwards(_) => None,
+            MonthsDelta::Backwards(d) => Some(d),
+        }
+    }
+
+    /// Get the contained `Months`, no matter which direction
+    pub fn abs(self) -> Months {
+        match self {
+            MonthsDelta::Backwards(d) => d,
+            MonthsDelta::Forwards(d) => d,
+        }
+    }
+}
+
+impl PartialEq for MonthsDelta {
+    fn eq(&self, other: &MonthsDelta) -> bool {
+        match (self, other) {
+            (MonthsDelta::Forwards(f1), MonthsDelta::Forwards(f2)) => f1 == f2,
+            (MonthsDelta::Backwards(b1), MonthsDelta::Backwards(b2)) => b1 == b2,
+            (MonthsDelta::Forwards(lhs), MonthsDelta::Backwards(rhs))
+            | (MonthsDelta::Backwards(lhs), MonthsDelta::Forwards(rhs)) => {
+                *lhs == Months(0) && *rhs == Months(0)
+            }
+        }
+    }
+}
+
+impl Eq for MonthsDelta {}
+
+impl From<Months> for MonthsDelta {
+    fn from(s: Months) -> Self {
+        MonthsDelta::Forwards(s)
+    }
+}
+
 /// An error resulting from reading `<Month>` value with `FromStr`.
 #[derive(Clone, PartialEq, Eq)]
 pub struct ParseMonthError {

src/naive/date.rs

@@ -17,7 +17,7 @@ use rkyv::{Archive, Deserialize, Serialize};
 use crate::format::DelayedFormat;
 use crate::format::{parse, ParseError, ParseResult, Parsed, StrftimeItems};
 use crate::format::{Item, Numeric, Pad};
-use crate::month::Months;
+use crate::month::{Months, MonthsDelta};
 use crate::naive::{IsoWeek, NaiveDateTime, NaiveTime};
 use crate::{Datelike, TimeDelta, Weekday};
 
@@ -1042,6 +1042,49 @@ impl NaiveDate {
         )
     }
 
+    /// Subtracts another `NaiveDate` from the current date.
+    /// Returns a `MonthsDelta` of the number of calendar months between the two dates.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use chrono::{NaiveDate, MonthsDelta, Months};
+    ///
+    /// assert_eq!(
+    ///     NaiveDate::from_ymd(2022, 4, 18).months_since(NaiveDate::from_ymd(2022, 4, 1)),
+    ///     MonthsDelta::Forwards(Months::new(0))
+    /// );
+    /// assert_eq!(
+    ///     NaiveDate::from_ymd(2022, 5, 1).months_since(NaiveDate::from_ymd(2022, 4, 30)),
+    ///     MonthsDelta::Forwards(Months::new(1))
+    /// );
+    /// assert_eq!(
+    ///     NaiveDate::from_ymd(2023, 5, 1).months_since(NaiveDate::from_ymd(2022, 4, 30)),
+    ///     MonthsDelta::Forwards(Months::new(13))
+    /// );
+    /// assert_eq!(
+    ///     NaiveDate::from_ymd(2022, 4, 1).months_since(NaiveDate::from_ymd(2022, 4, 18)),
+    ///     MonthsDelta::Backwards(Months::new(0))
+    /// );
+    /// assert_eq!(
+    ///     NaiveDate::from_ymd(2022, 4, 30).months_since(NaiveDate::from_ymd(2022, 5, 1)),
+    ///     MonthsDelta::Backwards(Months::new(1))
+    /// );
+    /// assert_eq!(
+    ///     NaiveDate::from_ymd(2022, 4, 30).months_since(NaiveDate::from_ymd(2023, 5, 1)),
+    ///     MonthsDelta::Backwards(Months::new(13))
+    /// );
+    /// ```
+    pub fn months_since(self, rhs: NaiveDate) -> MonthsDelta {
+        if self >= rhs {
+            let years = u32::try_from(self.year() - rhs.year()).expect("Will succeed");
+            MonthsDelta::Forwards(Months::new(years * 12 + self.month() - rhs.month()))
+        } else {
+            let years = u32::try_from((rhs.year() - self.year()).abs()).expect("Will succeed");
+            MonthsDelta::Backwards(Months::new(years * 12 + rhs.month() - self.month()))
+        }
+    }
+
     /// Formats the date with the specified formatting items.
     /// Otherwise it is the same as the ordinary `format` method.
     ///