Merge branch 'main' into fix/calendar-until-arithmetic

Author: poulsbo

components/calendar/benches/until.rs

@@ -5,8 +5,8 @@
 use criterion::{
     black_box, criterion_group, criterion_main, measurement::WallTime, BenchmarkGroup, Criterion,
 };
-use icu_calendar::options::DateDifferenceOptions;
-use icu_calendar::types::{DateDurationUnit, RataDie};
+use icu_calendar::options::{DateDifferenceOptions, DateDurationUnit};
+use icu_calendar::types::RataDie;
 use icu_calendar::{Calendar, Date};
 
 #[macro_use]

components/calendar/fuzz/fuzz_targets/until.rs

@@ -28,7 +28,7 @@ pub enum DateDurationUnit {
     Days,
 }
 
-impl From<DateDurationUnit> for icu_calendar::types::DateDurationUnit {
+impl From<DateDurationUnit> for icu_calendar::options::DateDurationUnit {
     fn from(other: DateDurationUnit) -> Self {
         match other {
             DateDurationUnit::Years => Self::Years,

components/calendar/src/calendar_arithmetic.rs

@@ -4,12 +4,12 @@
 
 use calendrical_calculations::rata_die::RataDie;
 
-use crate::duration::{DateDuration, DateDurationUnit};
+use crate::duration::DateDuration;
 use crate::error::{
     range_check, DateAddError, DateFromFieldsError, EcmaReferenceYearError, LunisolarDateError,
     MonthCodeParseError, MonthError, UnknownEraError,
 };
-use crate::options::{DateAddOptions, DateDifferenceOptions};
+use crate::options::{DateAddOptions, DateDifferenceOptions, DateDurationUnit};
 use crate::options::{DateFromFieldsOptions, MissingFieldsStrategy, Overflow};
 use crate::types::{DateFields, Month};
 use crate::{types, Calendar, DateError, RangeError};

components/calendar/src/duration.rs

@@ -20,7 +20,7 @@ use crate::error::DateDurationParseError;
 /// ```rust
 /// use icu::calendar::options::DateDifferenceOptions;
 /// use icu::calendar::types::DateDuration;
-/// use icu::calendar::types::DateDurationUnit;
+/// use icu::calendar::options::DateDurationUnit;
 /// use icu::calendar::types::Weekday;
 /// use icu::calendar::Date;
 ///
@@ -135,30 +135,6 @@ pub struct DateDuration {
     pub days: u64,
 }
 
-/// A "duration unit" used to specify the minimum or maximum duration of time to
-/// care about
-///
-/// <div class="stab unstable">
-/// 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
-/// including in SemVer minor releases. Do not use this type unless you are prepared for things to occasionally break.
-///
-/// Graduation tracking issue: [issue #3964](https://github.com/unicode-org/icu4x/issues/3964).
-/// </div>
-///
-/// ✨ *Enabled with the `unstable` Cargo feature.*
-#[derive(Copy, Clone, Eq, PartialEq, Debug)]
-#[allow(clippy::exhaustive_enums)] // this type should be stable
-pub enum DateDurationUnit {
-    /// Duration in years
-    Years,
-    /// Duration in months
-    Months,
-    /// Duration in weeks
-    Weeks,
-    /// Duration in days
-    Days,
-}
-
 impl DateDuration {
     /// Parses an ISO 8601 date-only duration string into a [`DateDuration`].
     ///

components/calendar/src/error.rs

@@ -570,7 +570,7 @@ mod unstable {
     /// use icu::calendar::error::MismatchedCalendarError;
     /// use icu::calendar::Date;
     /// use icu::calendar::options::DateDifferenceOptions;
-    /// use icu::calendar::types::DateDurationUnit;
+    /// use icu::calendar::options::DateDurationUnit;
     ///
     /// let d1 = Date::try_new_gregorian(2000, 1, 1).unwrap().to_any();
     /// let d2 = Date::try_new_persian(1562, 1, 1).unwrap().to_any();

components/calendar/src/options.rs

@@ -6,11 +6,13 @@
 
 #[cfg(feature = "unstable")]
 pub use unstable::{
-    DateAddOptions, DateDifferenceOptions, DateFromFieldsOptions, MissingFieldsStrategy, Overflow,
+    DateAddOptions, DateDifferenceOptions, DateDurationUnit, DateFromFieldsOptions,
+    MissingFieldsStrategy, Overflow,
 };
 #[cfg(not(feature = "unstable"))]
 pub(crate) use unstable::{
-    DateAddOptions, DateDifferenceOptions, DateFromFieldsOptions, MissingFieldsStrategy, Overflow,
+    DateAddOptions, DateDifferenceOptions, DateDurationUnit, DateFromFieldsOptions,
+    MissingFieldsStrategy, Overflow,
 };
 
 mod unstable {
@@ -177,12 +179,15 @@ mod unstable {
         /// associative or commutative in subsequent arithmetic operations, and it might require
         /// [`Overflow::Constrain`] in addition.
         ///
+        /// The resultant duration will not have any `weeks` value unless [`DateDurationUnit::Weeks`]
+        /// is explicitly specified as `largest_unit`.
+        ///
         /// # Examples
         ///
         /// ```
         /// use icu::calendar::options::DateDifferenceOptions;
         /// use icu::calendar::types::DateDuration;
-        /// use icu::calendar::types::DateDurationUnit;
+        /// use icu::calendar::options::DateDurationUnit;
         /// use icu::calendar::Date;
         ///
         /// let d1 = Date::try_new_iso(2025, 3, 31).unwrap();
@@ -206,6 +211,7 @@ mod unstable {
         /// assert_eq!(
         ///     d1.try_until_with_options(&d2, options_weeks).unwrap(),
         ///     DateDuration {
+        ///         // This is the only time there is a `weeks` value.
         ///         weeks: 58,
         ///         days: 4,
         ///         ..Default::default()
@@ -236,10 +242,10 @@ mod unstable {
         /// );
         /// ```
         ///
-        /// [`Months`]: crate::types::DateDurationUnit::Months
-        /// [`Years`]: crate::types::DateDurationUnit::Years
+        /// [`Months`]: crate::options::DateDurationUnit::Months
+        /// [`Years`]: crate::options::DateDurationUnit::Years
         /// [`DateDuration`]: crate::types::DateDuration
-        pub largest_unit: Option<crate::duration::DateDurationUnit>,
+        pub largest_unit: Option<DateDurationUnit>,
     }
 
     /// Whether to constrain or reject out-of-bounds values when constructing a Date.
@@ -410,6 +416,30 @@ mod unstable {
         /// the identity of an ordinal month changes from year to year.
         Ecma,
     }
+
+    /// A "duration unit" used to specify the minimum or maximum duration of time to
+    /// care about.
+    ///
+    /// <div class="stab unstable">
+    /// 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
+    /// including in SemVer minor releases. Do not use this type unless you are prepared for things to occasionally break.
+    ///
+    /// Graduation tracking issue: [issue #3964](https://github.com/unicode-org/icu4x/issues/3964).
+    /// </div>
+    ///
+    /// ✨ *Enabled with the `unstable` Cargo feature.*
+    #[derive(Copy, Clone, Eq, PartialEq, Debug)]
+    #[allow(clippy::exhaustive_enums)] // this type should be stable
+    pub enum DateDurationUnit {
+        /// Duration in years
+        Years,
+        /// Duration in months
+        Months,
+        /// Duration in weeks
+        Weeks,
+        /// Duration in days
+        Days,
+    }
 }
 #[cfg(test)]
 mod tests {

components/calendar/src/tests/arithmetic.rs

@@ -2,8 +2,8 @@
 // called LICENSE at the top level of the ICU4X source tree
 // (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
 
-use crate::options::{DateAddOptions, DateDifferenceOptions, Overflow};
-use crate::types::{DateDuration, DateDurationUnit, Month};
+use crate::options::{DateAddOptions, DateDifferenceOptions, DateDurationUnit, Overflow};
+use crate::types::{DateDuration, Month};
 use crate::{AsCalendar, Calendar, Date};
 use core::fmt;
 

components/calendar/src/tests/date_arithmetic_snapshot.rs

@@ -2,8 +2,8 @@
 // called LICENSE at the top level of the ICU4X source tree
 // (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
 
-use crate::options::{DateAddOptions, DateDifferenceOptions};
-use crate::types::{DateDuration, DateDurationUnit, RataDie};
+use crate::options::{DateAddOptions, DateDifferenceOptions, DateDurationUnit};
+use crate::types::{DateDuration, RataDie};
 use crate::Date;
 use insta::assert_snapshot;
 use std::fmt::Write;

components/calendar/src/tests/extrema.rs

@@ -6,8 +6,10 @@ use crate::calendar_arithmetic::{CONSTRUCTOR_YEAR_RANGE, GENEROUS_YEAR_RANGE, VA
 use crate::duration::DateDuration;
 use crate::error::DateAddError;
 use crate::error::DateFromFieldsError;
-use crate::options::{DateAddOptions, DateDifferenceOptions, DateFromFieldsOptions, Overflow};
-use crate::types::{DateDurationUnit, DateFields, Month};
+use crate::options::{
+    DateAddOptions, DateDifferenceOptions, DateDurationUnit, DateFromFieldsOptions, Overflow,
+};
+use crate::types::{DateFields, Month};
 use crate::Date;
 use calendrical_calculations::gregorian::fixed_from_gregorian;
 use calendrical_calculations::rata_die::RataDie;

components/calendar/src/types.rs

@@ -12,7 +12,7 @@ use zerovec::ule::AsULE;
 
 // Export the duration types from here
 #[cfg(feature = "unstable")]
-pub use crate::duration::{DateDuration, DateDurationUnit};
+pub use crate::duration::DateDuration;
 use crate::{calendar_arithmetic::ArithmeticDate, error::MonthCodeParseError};
 
 #[cfg(feature = "unstable")]