chrono/naive/date/
mod.rs

1// This is a part of Chrono.
2// See README.md and LICENSE.txt for details.
3
4//! ISO 8601 calendar date without timezone.
5//!
6//! The implementation is optimized for determining year, month, day and day of week.
7//!
8//! Format of `NaiveDate`:
9//! `YYYY_YYYY_YYYY_YYYY_YYYO_OOOO_OOOO_LWWW`
10//! `Y`: Year
11//! `O`: Ordinal
12//! `L`: leap year flag (1 = common year, 0 is leap year)
13//! `W`: weekday before the first day of the year
14//! `LWWW`: will also be referred to as the year flags (`F`)
15
16#[cfg(feature = "alloc")]
17use core::borrow::Borrow;
18use core::iter::FusedIterator;
19use core::num::NonZeroI32;
20use core::ops::{Add, AddAssign, Sub, SubAssign};
21use core::{fmt, str};
22
23#[cfg(any(feature = "rkyv", feature = "rkyv-16", feature = "rkyv-32", feature = "rkyv-64"))]
24use rkyv::{Archive, Deserialize, Serialize};
25
26/// L10n locales.
27#[cfg(all(feature = "unstable-locales", feature = "alloc"))]
28use pure_rust_locales::Locale;
29
30use super::internals::{Mdf, YearFlags};
31use crate::datetime::UNIX_EPOCH_DAY;
32#[cfg(feature = "alloc")]
33use crate::format::DelayedFormat;
34use crate::format::{
35    Item, Numeric, Pad, ParseError, ParseResult, Parsed, StrftimeItems, parse, parse_and_remainder,
36    write_hundreds,
37};
38use crate::month::Months;
39use crate::naive::{Days, IsoWeek, NaiveDateTime, NaiveTime, NaiveWeek};
40use crate::{Datelike, TimeDelta, Weekday};
41use crate::{expect, try_opt};
42
43#[cfg(test)]
44mod tests;
45
46/// ISO 8601 calendar date without timezone.
47/// Allows for every [proleptic Gregorian date] from Jan 1, 262145 BCE to Dec 31, 262143 CE.
48/// Also supports the conversion from ISO 8601 ordinal and week date.
49///
50/// # Calendar Date
51///
52/// The ISO 8601 **calendar date** follows the proleptic Gregorian calendar.
53/// It is like a normal civil calendar but note some slight differences:
54///
55/// * Dates before the Gregorian calendar's inception in 1582 are defined via the extrapolation.
56///   Be careful, as historical dates are often noted in the Julian calendar and others
57///   and the transition to Gregorian may differ across countries (as late as early 20C).
58///
59///   (Some example: Both Shakespeare from Britain and Cervantes from Spain seemingly died
60///   on the same calendar date---April 23, 1616---but in the different calendar.
61///   Britain used the Julian calendar at that time, so Shakespeare's death is later.)
62///
63/// * ISO 8601 calendars have the year 0, which is 1 BCE (a year before 1 CE).
64///   If you need a typical BCE/BC and CE/AD notation for year numbers,
65///   use the [`Datelike::year_ce`] method.
66///
67/// # Week Date
68///
69/// The ISO 8601 **week date** is a triple of year number, week number
70/// and [day of the week](Weekday) with the following rules:
71///
72/// * A week consists of Monday through Sunday, and is always numbered within some year.
73///   The week number ranges from 1 to 52 or 53 depending on the year.
74///
75/// * The week 1 of given year is defined as the first week containing January 4 of that year,
76///   or equivalently, the first week containing four or more days in that year.
77///
78/// * The year number in the week date may *not* correspond to the actual Gregorian year.
79///   For example, January 3, 2016 (Sunday) was on the last (53rd) week of 2015.
80///
81/// Chrono's date types default to the ISO 8601 [calendar date](#calendar-date), but
82/// [`Datelike::iso_week`] and [`Datelike::weekday`] methods can be used to get the corresponding
83/// week date.
84///
85/// # Ordinal Date
86///
87/// The ISO 8601 **ordinal date** is a pair of year number and day of the year ("ordinal").
88/// The ordinal number ranges from 1 to 365 or 366 depending on the year.
89/// The year number is the same as that of the [calendar date](#calendar-date).
90///
91/// This is currently the internal format of Chrono's date types.
92///
93/// [proleptic Gregorian date]: crate::NaiveDate#calendar-date
94#[derive(PartialEq, Eq, Hash, PartialOrd, Ord, Copy, Clone)]
95#[cfg_attr(
96    any(feature = "rkyv", feature = "rkyv-16", feature = "rkyv-32", feature = "rkyv-64"),
97    derive(Archive, Deserialize, Serialize),
98    archive(compare(PartialEq, PartialOrd)),
99    archive_attr(derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash))
100)]
101#[cfg_attr(feature = "rkyv-validation", archive(check_bytes))]
102pub struct NaiveDate {
103    yof: NonZeroI32, // (year << 13) | of
104}
105
106/// The minimum possible `NaiveDate` (January 1, 262145 BCE).
107#[deprecated(since = "0.4.20", note = "Use NaiveDate::MIN instead")]
108pub const MIN_DATE: NaiveDate = NaiveDate::MIN;
109/// The maximum possible `NaiveDate` (December 31, 262143 CE).
110#[deprecated(since = "0.4.20", note = "Use NaiveDate::MAX instead")]
111pub const MAX_DATE: NaiveDate = NaiveDate::MAX;
112
113#[cfg(all(feature = "arbitrary", feature = "std"))]
114impl arbitrary::Arbitrary<'_> for NaiveDate {
115    fn arbitrary(u: &mut arbitrary::Unstructured) -> arbitrary::Result<NaiveDate> {
116        let year = u.int_in_range(MIN_YEAR..=MAX_YEAR)?;
117        let max_days = YearFlags::from_year(year).ndays();
118        let ord = u.int_in_range(1..=max_days)?;
119        NaiveDate::from_yo_opt(year, ord).ok_or(arbitrary::Error::IncorrectFormat)
120    }
121}
122
123impl NaiveDate {
124    pub(crate) fn weeks_from(&self, day: Weekday) -> i32 {
125        (self.ordinal() as i32 - self.weekday().days_since(day) as i32 + 6) / 7
126    }
127
128    /// Makes a new `NaiveDate` from year, ordinal and flags.
129    /// Does not check whether the flags are correct for the provided year.
130    const fn from_ordinal_and_flags(
131        year: i32,
132        ordinal: u32,
133        flags: YearFlags,
134    ) -> Option<NaiveDate> {
135        if year < MIN_YEAR || year > MAX_YEAR {
136            return None; // Out-of-range
137        }
138        if ordinal == 0 || ordinal > 366 {
139            return None; // Invalid
140        }
141        debug_assert!(YearFlags::from_year(year).0 == flags.0);
142        let yof = (year << 13) | (ordinal << 4) as i32 | flags.0 as i32;
143        match yof & OL_MASK <= MAX_OL {
144            true => Some(NaiveDate::from_yof(yof)),
145            false => None, // Does not exist: Ordinal 366 in a common year.
146        }
147    }
148
149    /// Makes a new `NaiveDate` from year and packed month-day-flags.
150    /// Does not check whether the flags are correct for the provided year.
151    const fn from_mdf(year: i32, mdf: Mdf) -> Option<NaiveDate> {
152        if year < MIN_YEAR || year > MAX_YEAR {
153            return None; // Out-of-range
154        }
155        Some(NaiveDate::from_yof((year << 13) | try_opt!(mdf.ordinal_and_flags())))
156    }
157
158    /// Makes a new `NaiveDate` from the [calendar date](#calendar-date)
159    /// (year, month and day).
160    ///
161    /// # Panics
162    ///
163    /// Panics if the specified calendar day does not exist, on invalid values for `month` or `day`,
164    /// or if `year` is out of range for `NaiveDate`.
165    #[deprecated(since = "0.4.23", note = "use `from_ymd_opt()` instead")]
166    #[must_use]
167    pub const fn from_ymd(year: i32, month: u32, day: u32) -> NaiveDate {
168        expect(NaiveDate::from_ymd_opt(year, month, day), "invalid or out-of-range date")
169    }
170
171    /// Makes a new `NaiveDate` from the [calendar date](#calendar-date)
172    /// (year, month and day).
173    ///
174    /// # Errors
175    ///
176    /// Returns `None` if:
177    /// - The specified calendar day does not exist (for example 2023-04-31).
178    /// - The value for `month` or `day` is invalid.
179    /// - `year` is out of range for `NaiveDate`.
180    ///
181    /// # Example
182    ///
183    /// ```
184    /// use chrono::NaiveDate;
185    ///
186    /// let from_ymd_opt = NaiveDate::from_ymd_opt;
187    ///
188    /// assert!(from_ymd_opt(2015, 3, 14).is_some());
189    /// assert!(from_ymd_opt(2015, 0, 14).is_none());
190    /// assert!(from_ymd_opt(2015, 2, 29).is_none());
191    /// assert!(from_ymd_opt(-4, 2, 29).is_some()); // 5 BCE is a leap year
192    /// assert!(from_ymd_opt(400000, 1, 1).is_none());
193    /// assert!(from_ymd_opt(-400000, 1, 1).is_none());
194    /// ```
195    #[must_use]
196    pub const fn from_ymd_opt(year: i32, month: u32, day: u32) -> Option<NaiveDate> {
197        let flags = YearFlags::from_year(year);
198
199        if let Some(mdf) = Mdf::new(month, day, flags) {
200            NaiveDate::from_mdf(year, mdf)
201        } else {
202            None
203        }
204    }
205
206    /// Makes a new `NaiveDate` from the [ordinal date](#ordinal-date)
207    /// (year and day of the year).
208    ///
209    /// # Panics
210    ///
211    /// Panics if the specified ordinal day does not exist, on invalid values for `ordinal`, or if
212    /// `year` is out of range for `NaiveDate`.
213    #[deprecated(since = "0.4.23", note = "use `from_yo_opt()` instead")]
214    #[must_use]
215    pub const fn from_yo(year: i32, ordinal: u32) -> NaiveDate {
216        expect(NaiveDate::from_yo_opt(year, ordinal), "invalid or out-of-range date")
217    }
218
219    /// Makes a new `NaiveDate` from the [ordinal date](#ordinal-date)
220    /// (year and day of the year).
221    ///
222    /// # Errors
223    ///
224    /// Returns `None` if:
225    /// - The specified ordinal day does not exist (for example 2023-366).
226    /// - The value for `ordinal` is invalid (for example: `0`, `400`).
227    /// - `year` is out of range for `NaiveDate`.
228    ///
229    /// # Example
230    ///
231    /// ```
232    /// use chrono::NaiveDate;
233    ///
234    /// let from_yo_opt = NaiveDate::from_yo_opt;
235    ///
236    /// assert!(from_yo_opt(2015, 100).is_some());
237    /// assert!(from_yo_opt(2015, 0).is_none());
238    /// assert!(from_yo_opt(2015, 365).is_some());
239    /// assert!(from_yo_opt(2015, 366).is_none());
240    /// assert!(from_yo_opt(-4, 366).is_some()); // 5 BCE is a leap year
241    /// assert!(from_yo_opt(400000, 1).is_none());
242    /// assert!(from_yo_opt(-400000, 1).is_none());
243    /// ```
244    #[must_use]
245    pub const fn from_yo_opt(year: i32, ordinal: u32) -> Option<NaiveDate> {
246        let flags = YearFlags::from_year(year);
247        NaiveDate::from_ordinal_and_flags(year, ordinal, flags)
248    }
249
250    /// Makes a new `NaiveDate` from the [ISO week date](#week-date)
251    /// (year, week number and day of the week).
252    /// The resulting `NaiveDate` may have a different year from the input year.
253    ///
254    /// # Panics
255    ///
256    /// Panics if the specified week does not exist in that year, on invalid values for `week`, or
257    /// if the resulting date is out of range for `NaiveDate`.
258    #[deprecated(since = "0.4.23", note = "use `from_isoywd_opt()` instead")]
259    #[must_use]
260    pub const fn from_isoywd(year: i32, week: u32, weekday: Weekday) -> NaiveDate {
261        expect(NaiveDate::from_isoywd_opt(year, week, weekday), "invalid or out-of-range date")
262    }
263
264    /// Makes a new `NaiveDate` from the [ISO week date](#week-date)
265    /// (year, week number and day of the week).
266    /// The resulting `NaiveDate` may have a different year from the input year.
267    ///
268    /// # Errors
269    ///
270    /// Returns `None` if:
271    /// - The specified week does not exist in that year (for example 2023 week 53).
272    /// - The value for `week` is invalid (for example: `0`, `60`).
273    /// - If the resulting date is out of range for `NaiveDate`.
274    ///
275    /// # Example
276    ///
277    /// ```
278    /// use chrono::{NaiveDate, Weekday};
279    ///
280    /// let from_ymd = |y, m, d| NaiveDate::from_ymd_opt(y, m, d).unwrap();
281    /// let from_isoywd_opt = NaiveDate::from_isoywd_opt;
282    ///
283    /// assert_eq!(from_isoywd_opt(2015, 0, Weekday::Sun), None);
284    /// assert_eq!(from_isoywd_opt(2015, 10, Weekday::Sun), Some(from_ymd(2015, 3, 8)));
285    /// assert_eq!(from_isoywd_opt(2015, 30, Weekday::Mon), Some(from_ymd(2015, 7, 20)));
286    /// assert_eq!(from_isoywd_opt(2015, 60, Weekday::Mon), None);
287    ///
288    /// assert_eq!(from_isoywd_opt(400000, 10, Weekday::Fri), None);
289    /// assert_eq!(from_isoywd_opt(-400000, 10, Weekday::Sat), None);
290    /// ```
291    ///
292    /// The year number of ISO week date may differ from that of the calendar date.
293    ///
294    /// ```
295    /// # use chrono::{NaiveDate, Weekday};
296    /// # let from_ymd = |y, m, d| NaiveDate::from_ymd_opt(y, m, d).unwrap();
297    /// # let from_isoywd_opt = NaiveDate::from_isoywd_opt;
298    /// //           Mo Tu We Th Fr Sa Su
299    /// // 2014-W52  22 23 24 25 26 27 28    has 4+ days of new year,
300    /// // 2015-W01  29 30 31  1  2  3  4 <- so this is the first week
301    /// assert_eq!(from_isoywd_opt(2014, 52, Weekday::Sun), Some(from_ymd(2014, 12, 28)));
302    /// assert_eq!(from_isoywd_opt(2014, 53, Weekday::Mon), None);
303    /// assert_eq!(from_isoywd_opt(2015, 1, Weekday::Mon), Some(from_ymd(2014, 12, 29)));
304    ///
305    /// // 2015-W52  21 22 23 24 25 26 27    has 4+ days of old year,
306    /// // 2015-W53  28 29 30 31  1  2  3 <- so this is the last week
307    /// // 2016-W01   4  5  6  7  8  9 10
308    /// assert_eq!(from_isoywd_opt(2015, 52, Weekday::Sun), Some(from_ymd(2015, 12, 27)));
309    /// assert_eq!(from_isoywd_opt(2015, 53, Weekday::Sun), Some(from_ymd(2016, 1, 3)));
310    /// assert_eq!(from_isoywd_opt(2015, 54, Weekday::Mon), None);
311    /// assert_eq!(from_isoywd_opt(2016, 1, Weekday::Mon), Some(from_ymd(2016, 1, 4)));
312    /// ```
313    #[must_use]
314    pub const fn from_isoywd_opt(year: i32, week: u32, weekday: Weekday) -> Option<NaiveDate> {
315        let flags = YearFlags::from_year(year);
316        let nweeks = flags.nisoweeks();
317        if week == 0 || week > nweeks {
318            return None;
319        }
320        // ordinal = week ordinal - delta
321        let weekord = week * 7 + weekday as u32;
322        let delta = flags.isoweek_delta();
323        let (year, ordinal, flags) = if weekord <= delta {
324            // ordinal < 1, previous year
325            let prevflags = YearFlags::from_year(year - 1);
326            (year - 1, weekord + prevflags.ndays() - delta, prevflags)
327        } else {
328            let ordinal = weekord - delta;
329            let ndays = flags.ndays();
330            if ordinal <= ndays {
331                // this year
332                (year, ordinal, flags)
333            } else {
334                // ordinal > ndays, next year
335                let nextflags = YearFlags::from_year(year + 1);
336                (year + 1, ordinal - ndays, nextflags)
337            }
338        };
339        NaiveDate::from_ordinal_and_flags(year, ordinal, flags)
340    }
341
342    /// Makes a new `NaiveDate` from a day's number in the proleptic Gregorian calendar, with
343    /// January 1, 1 being day 1.
344    ///
345    /// # Panics
346    ///
347    /// Panics if the date is out of range.
348    #[deprecated(since = "0.4.23", note = "use `from_num_days_from_ce_opt()` instead")]
349    #[inline]
350    #[must_use]
351    pub const fn from_num_days_from_ce(days: i32) -> NaiveDate {
352        expect(NaiveDate::from_num_days_from_ce_opt(days), "out-of-range date")
353    }
354
355    /// Makes a new `NaiveDate` from a day's number in the proleptic Gregorian calendar, with
356    /// January 1, 1 being day 1.
357    ///
358    /// # Errors
359    ///
360    /// Returns `None` if the date is out of range.
361    ///
362    /// # Example
363    ///
364    /// ```
365    /// use chrono::NaiveDate;
366    ///
367    /// let from_ndays_opt = NaiveDate::from_num_days_from_ce_opt;
368    /// let from_ymd = |y, m, d| NaiveDate::from_ymd_opt(y, m, d).unwrap();
369    ///
370    /// assert_eq!(from_ndays_opt(730_000), Some(from_ymd(1999, 9, 3)));
371    /// assert_eq!(from_ndays_opt(1), Some(from_ymd(1, 1, 1)));
372    /// assert_eq!(from_ndays_opt(0), Some(from_ymd(0, 12, 31)));
373    /// assert_eq!(from_ndays_opt(-1), Some(from_ymd(0, 12, 30)));
374    /// assert_eq!(from_ndays_opt(100_000_000), None);
375    /// assert_eq!(from_ndays_opt(-100_000_000), None);
376    /// ```
377    #[must_use]
378    pub const fn from_num_days_from_ce_opt(days: i32) -> Option<NaiveDate> {
379        let days = try_opt!(days.checked_add(365)); // make December 31, 1 BCE equal to day 0
380        let year_div_400 = days.div_euclid(146_097);
381        let cycle = days.rem_euclid(146_097);
382        let (year_mod_400, ordinal) = cycle_to_yo(cycle as u32);
383        let flags = YearFlags::from_year_mod_400(year_mod_400 as i32);
384        NaiveDate::from_ordinal_and_flags(year_div_400 * 400 + year_mod_400 as i32, ordinal, flags)
385    }
386
387    /// Makes a new `NaiveDate` from a day's number in the proleptic Gregorian calendar, with
388    /// January 1, 1970 being day 0.
389    ///
390    /// # Errors
391    ///
392    /// Returns `None` if the date is out of range.
393    ///
394    /// # Example
395    ///
396    /// ```
397    /// use chrono::NaiveDate;
398    ///
399    /// let from_ndays_opt = NaiveDate::from_epoch_days;
400    /// let from_ymd = |y, m, d| NaiveDate::from_ymd_opt(y, m, d).unwrap();
401    ///
402    /// assert_eq!(from_ndays_opt(-719_162), Some(from_ymd(1, 1, 1)));
403    /// assert_eq!(from_ndays_opt(1), Some(from_ymd(1970, 1, 2)));
404    /// assert_eq!(from_ndays_opt(0), Some(from_ymd(1970, 1, 1)));
405    /// assert_eq!(from_ndays_opt(-1), Some(from_ymd(1969, 12, 31)));
406    /// assert_eq!(from_ndays_opt(13036), Some(from_ymd(2005, 9, 10)));
407    /// assert_eq!(from_ndays_opt(100_000_000), None);
408    /// assert_eq!(from_ndays_opt(-100_000_000), None);
409    /// ```
410    #[must_use]
411    pub const fn from_epoch_days(days: i32) -> Option<NaiveDate> {
412        let ce_days = try_opt!(days.checked_add(UNIX_EPOCH_DAY as i32));
413        NaiveDate::from_num_days_from_ce_opt(ce_days)
414    }
415
416    /// Makes a new `NaiveDate` by counting the number of occurrences of a particular day-of-week
417    /// since the beginning of the given month. For instance, if you want the 2nd Friday of March
418    /// 2017, you would use `NaiveDate::from_weekday_of_month(2017, 3, Weekday::Fri, 2)`.
419    ///
420    /// `n` is 1-indexed.
421    ///
422    /// # Panics
423    ///
424    /// Panics if the specified day does not exist in that month, on invalid values for `month` or
425    /// `n`, or if `year` is out of range for `NaiveDate`.
426    #[deprecated(since = "0.4.23", note = "use `from_weekday_of_month_opt()` instead")]
427    #[must_use]
428    pub const fn from_weekday_of_month(
429        year: i32,
430        month: u32,
431        weekday: Weekday,
432        n: u8,
433    ) -> NaiveDate {
434        expect(NaiveDate::from_weekday_of_month_opt(year, month, weekday, n), "out-of-range date")
435    }
436
437    /// Makes a new `NaiveDate` by counting the number of occurrences of a particular day-of-week
438    /// since the beginning of the given month. For instance, if you want the 2nd Friday of March
439    /// 2017, you would use `NaiveDate::from_weekday_of_month(2017, 3, Weekday::Fri, 2)`.
440    ///
441    /// `n` is 1-indexed.
442    ///
443    /// # Errors
444    ///
445    /// Returns `None` if:
446    /// - The specified day does not exist in that month (for example the 5th Monday of Apr. 2023).
447    /// - The value for `month` or `n` is invalid.
448    /// - `year` is out of range for `NaiveDate`.
449    ///
450    /// # Example
451    ///
452    /// ```
453    /// use chrono::{NaiveDate, Weekday};
454    /// assert_eq!(
455    ///     NaiveDate::from_weekday_of_month_opt(2017, 3, Weekday::Fri, 2),
456    ///     NaiveDate::from_ymd_opt(2017, 3, 10)
457    /// )
458    /// ```
459    #[must_use]
460    pub const fn from_weekday_of_month_opt(
461        year: i32,
462        month: u32,
463        weekday: Weekday,
464        n: u8,
465    ) -> Option<NaiveDate> {
466        if n == 0 {
467            return None;
468        }
469        let first = try_opt!(NaiveDate::from_ymd_opt(year, month, 1)).weekday();
470        let first_to_dow = (7 + weekday.number_from_monday() - first.number_from_monday()) % 7;
471        let day = (n - 1) as u32 * 7 + first_to_dow + 1;
472        NaiveDate::from_ymd_opt(year, month, day)
473    }
474
475    /// Parses a string with the specified format string and returns a new `NaiveDate`.
476    /// See the [`format::strftime` module](crate::format::strftime)
477    /// on the supported escape sequences.
478    ///
479    /// # Example
480    ///
481    /// ```
482    /// use chrono::NaiveDate;
483    ///
484    /// let parse_from_str = NaiveDate::parse_from_str;
485    ///
486    /// assert_eq!(
487    ///     parse_from_str("2015-09-05", "%Y-%m-%d"),
488    ///     Ok(NaiveDate::from_ymd_opt(2015, 9, 5).unwrap())
489    /// );
490    /// assert_eq!(
491    ///     parse_from_str("5sep2015", "%d%b%Y"),
492    ///     Ok(NaiveDate::from_ymd_opt(2015, 9, 5).unwrap())
493    /// );
494    /// ```
495    ///
496    /// Time and offset is ignored for the purpose of parsing.
497    ///
498    /// ```
499    /// # use chrono::NaiveDate;
500    /// # let parse_from_str = NaiveDate::parse_from_str;
501    /// assert_eq!(
502    ///     parse_from_str("2014-5-17T12:34:56+09:30", "%Y-%m-%dT%H:%M:%S%z"),
503    ///     Ok(NaiveDate::from_ymd_opt(2014, 5, 17).unwrap())
504    /// );
505    /// ```
506    ///
507    /// Out-of-bound dates or insufficient fields are errors.
508    ///
509    /// ```
510    /// # use chrono::NaiveDate;
511    /// # let parse_from_str = NaiveDate::parse_from_str;
512    /// assert!(parse_from_str("2015/9", "%Y/%m").is_err());
513    /// assert!(parse_from_str("2015/9/31", "%Y/%m/%d").is_err());
514    /// ```
515    ///
516    /// All parsed fields should be consistent to each other, otherwise it's an error.
517    ///
518    /// ```
519    /// # use chrono::NaiveDate;
520    /// # let parse_from_str = NaiveDate::parse_from_str;
521    /// assert!(parse_from_str("Sat, 09 Aug 2013", "%a, %d %b %Y").is_err());
522    /// ```
523    pub fn parse_from_str(s: &str, fmt: &str) -> ParseResult<NaiveDate> {
524        let mut parsed = Parsed::new();
525        parse(&mut parsed, s, StrftimeItems::new(fmt))?;
526        parsed.to_naive_date()
527    }
528
529    /// Parses a string from a user-specified format into a new `NaiveDate` value, and a slice with
530    /// the remaining portion of the string.
531    /// See the [`format::strftime` module](crate::format::strftime)
532    /// on the supported escape sequences.
533    ///
534    /// Similar to [`parse_from_str`](#method.parse_from_str).
535    ///
536    /// # Example
537    ///
538    /// ```rust
539    /// # use chrono::{NaiveDate};
540    /// let (date, remainder) =
541    ///     NaiveDate::parse_and_remainder("2015-02-18 trailing text", "%Y-%m-%d").unwrap();
542    /// assert_eq!(date, NaiveDate::from_ymd_opt(2015, 2, 18).unwrap());
543    /// assert_eq!(remainder, " trailing text");
544    /// ```
545    pub fn parse_and_remainder<'a>(s: &'a str, fmt: &str) -> ParseResult<(NaiveDate, &'a str)> {
546        let mut parsed = Parsed::new();
547        let remainder = parse_and_remainder(&mut parsed, s, StrftimeItems::new(fmt))?;
548        parsed.to_naive_date().map(|d| (d, remainder))
549    }
550
551    /// Add a duration in [`Months`] to the date
552    ///
553    /// Uses the last day of the month if the day does not exist in the resulting month.
554    ///
555    /// # Errors
556    ///
557    /// Returns `None` if the resulting date would be out of range.
558    ///
559    /// # Example
560    ///
561    /// ```
562    /// # use chrono::{NaiveDate, Months};
563    /// assert_eq!(
564    ///     NaiveDate::from_ymd_opt(2022, 2, 20).unwrap().checked_add_months(Months::new(6)),
565    ///     Some(NaiveDate::from_ymd_opt(2022, 8, 20).unwrap())
566    /// );
567    /// assert_eq!(
568    ///     NaiveDate::from_ymd_opt(2022, 7, 31).unwrap().checked_add_months(Months::new(2)),
569    ///     Some(NaiveDate::from_ymd_opt(2022, 9, 30).unwrap())
570    /// );
571    /// ```
572    #[must_use]
573    pub const fn checked_add_months(self, months: Months) -> Option<Self> {
574        if months.0 == 0 {
575            return Some(self);
576        }
577
578        match months.0 <= i32::MAX as u32 {
579            true => self.diff_months(months.0 as i32),
580            false => None,
581        }
582    }
583
584    /// Subtract a duration in [`Months`] from the date
585    ///
586    /// Uses the last day of the month if the day does not exist in the resulting month.
587    ///
588    /// # Errors
589    ///
590    /// Returns `None` if the resulting date would be out of range.
591    ///
592    /// # Example
593    ///
594    /// ```
595    /// # use chrono::{NaiveDate, Months};
596    /// assert_eq!(
597    ///     NaiveDate::from_ymd_opt(2022, 2, 20).unwrap().checked_sub_months(Months::new(6)),
598    ///     Some(NaiveDate::from_ymd_opt(2021, 8, 20).unwrap())
599    /// );
600    ///
601    /// assert_eq!(
602    ///     NaiveDate::from_ymd_opt(2014, 1, 1)
603    ///         .unwrap()
604    ///         .checked_sub_months(Months::new(core::i32::MAX as u32 + 1)),
605    ///     None
606    /// );
607    /// ```
608    #[must_use]
609    pub const fn checked_sub_months(self, months: Months) -> Option<Self> {
610        if months.0 == 0 {
611            return Some(self);
612        }
613
614        match months.0 <= i32::MAX as u32 {
615            true => self.diff_months(-(months.0 as i32)),
616            false => None,
617        }
618    }
619
620    const fn diff_months(self, months: i32) -> Option<Self> {
621        let months = try_opt!((self.year() * 12 + self.month() as i32 - 1).checked_add(months));
622        let year = months.div_euclid(12);
623        let month = months.rem_euclid(12) as u32 + 1;
624
625        // Clamp original day in case new month is shorter
626        let flags = YearFlags::from_year(year);
627        let feb_days = if flags.ndays() == 366 { 29 } else { 28 };
628        let days = [31, feb_days, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];
629        let day_max = days[(month - 1) as usize];
630        let mut day = self.day();
631        if day > day_max {
632            day = day_max;
633        };
634
635        NaiveDate::from_ymd_opt(year, month, day)
636    }
637
638    /// Add a duration in [`Days`] to the date
639    ///
640    /// # Errors
641    ///
642    /// Returns `None` if the resulting date would be out of range.
643    ///
644    /// # Example
645    ///
646    /// ```
647    /// # use chrono::{NaiveDate, Days};
648    /// assert_eq!(
649    ///     NaiveDate::from_ymd_opt(2022, 2, 20).unwrap().checked_add_days(Days::new(9)),
650    ///     Some(NaiveDate::from_ymd_opt(2022, 3, 1).unwrap())
651    /// );
652    /// assert_eq!(
653    ///     NaiveDate::from_ymd_opt(2022, 7, 31).unwrap().checked_add_days(Days::new(2)),
654    ///     Some(NaiveDate::from_ymd_opt(2022, 8, 2).unwrap())
655    /// );
656    /// assert_eq!(
657    ///     NaiveDate::from_ymd_opt(2022, 7, 31).unwrap().checked_add_days(Days::new(1000000000000)),
658    ///     None
659    /// );
660    /// ```
661    #[must_use]
662    pub const fn checked_add_days(self, days: Days) -> Option<Self> {
663        match days.0 <= i32::MAX as u64 {
664            true => self.add_days(days.0 as i32),
665            false => None,
666        }
667    }
668
669    /// Subtract a duration in [`Days`] from the date
670    ///
671    /// # Errors
672    ///
673    /// Returns `None` if the resulting date would be out of range.
674    ///
675    /// # Example
676    ///
677    /// ```
678    /// # use chrono::{NaiveDate, Days};
679    /// assert_eq!(
680    ///     NaiveDate::from_ymd_opt(2022, 2, 20).unwrap().checked_sub_days(Days::new(6)),
681    ///     Some(NaiveDate::from_ymd_opt(2022, 2, 14).unwrap())
682    /// );
683    /// assert_eq!(
684    ///     NaiveDate::from_ymd_opt(2022, 2, 20).unwrap().checked_sub_days(Days::new(1000000000000)),
685    ///     None
686    /// );
687    /// ```
688    #[must_use]
689    pub const fn checked_sub_days(self, days: Days) -> Option<Self> {
690        match days.0 <= i32::MAX as u64 {
691            true => self.add_days(-(days.0 as i32)),
692            false => None,
693        }
694    }
695
696    /// Add a duration of `i32` days to the date.
697    pub(crate) const fn add_days(self, days: i32) -> Option<Self> {
698        // Fast path if the result is within the same year.
699        // Also `DateTime::checked_(add|sub)_days` relies on this path, because if the value remains
700        // within the year it doesn't do a check if the year is in range.
701        // This way `DateTime:checked_(add|sub)_days(Days::new(0))` can be a no-op on dates were the
702        // local datetime is beyond `NaiveDate::{MIN, MAX}.
703        const ORDINAL_MASK: i32 = 0b1_1111_1111_0000;
704        if let Some(ordinal) = ((self.yof() & ORDINAL_MASK) >> 4).checked_add(days) {
705            if ordinal > 0 && ordinal <= (365 + self.leap_year() as i32) {
706                let year_and_flags = self.yof() & !ORDINAL_MASK;
707                return Some(NaiveDate::from_yof(year_and_flags | (ordinal << 4)));
708            }
709        }
710        // do the full check
711        let year = self.year();
712        let (mut year_div_400, year_mod_400) = div_mod_floor(year, 400);
713        let cycle = yo_to_cycle(year_mod_400 as u32, self.ordinal());
714        let cycle = try_opt!((cycle as i32).checked_add(days));
715        let (cycle_div_400y, cycle) = div_mod_floor(cycle, 146_097);
716        year_div_400 += cycle_div_400y;
717
718        let (year_mod_400, ordinal) = cycle_to_yo(cycle as u32);
719        let flags = YearFlags::from_year_mod_400(year_mod_400 as i32);
720        NaiveDate::from_ordinal_and_flags(year_div_400 * 400 + year_mod_400 as i32, ordinal, flags)
721    }
722
723    /// Makes a new `NaiveDateTime` from the current date and given `NaiveTime`.
724    ///
725    /// # Example
726    ///
727    /// ```
728    /// use chrono::{NaiveDate, NaiveDateTime, NaiveTime};
729    ///
730    /// let d = NaiveDate::from_ymd_opt(2015, 6, 3).unwrap();
731    /// let t = NaiveTime::from_hms_milli_opt(12, 34, 56, 789).unwrap();
732    ///
733    /// let dt: NaiveDateTime = d.and_time(t);
734    /// assert_eq!(dt.date(), d);
735    /// assert_eq!(dt.time(), t);
736    /// ```
737    #[inline]
738    #[must_use]
739    pub const fn and_time(&self, time: NaiveTime) -> NaiveDateTime {
740        NaiveDateTime::new(*self, time)
741    }
742
743    /// Makes a new `NaiveDateTime` from the current date, hour, minute and second.
744    ///
745    /// No [leap second](./struct.NaiveTime.html#leap-second-handling) is allowed here;
746    /// use `NaiveDate::and_hms_*` methods with a subsecond parameter instead.
747    ///
748    /// # Panics
749    ///
750    /// Panics on invalid hour, minute and/or second.
751    #[deprecated(since = "0.4.23", note = "use `and_hms_opt()` instead")]
752    #[inline]
753    #[must_use]
754    pub const fn and_hms(&self, hour: u32, min: u32, sec: u32) -> NaiveDateTime {
755        expect(self.and_hms_opt(hour, min, sec), "invalid time")
756    }
757
758    /// Makes a new `NaiveDateTime` from the current date, hour, minute and second.
759    ///
760    /// No [leap second](./struct.NaiveTime.html#leap-second-handling) is allowed here;
761    /// use `NaiveDate::and_hms_*_opt` methods with a subsecond parameter instead.
762    ///
763    /// # Errors
764    ///
765    /// Returns `None` on invalid hour, minute and/or second.
766    ///
767    /// # Example
768    ///
769    /// ```
770    /// use chrono::NaiveDate;
771    ///
772    /// let d = NaiveDate::from_ymd_opt(2015, 6, 3).unwrap();
773    /// assert!(d.and_hms_opt(12, 34, 56).is_some());
774    /// assert!(d.and_hms_opt(12, 34, 60).is_none()); // use `and_hms_milli_opt` instead
775    /// assert!(d.and_hms_opt(12, 60, 56).is_none());
776    /// assert!(d.and_hms_opt(24, 34, 56).is_none());
777    /// ```
778    #[inline]
779    #[must_use]
780    pub const fn and_hms_opt(&self, hour: u32, min: u32, sec: u32) -> Option<NaiveDateTime> {
781        let time = try_opt!(NaiveTime::from_hms_opt(hour, min, sec));
782        Some(self.and_time(time))
783    }
784
785    /// Makes a new `NaiveDateTime` from the current date, hour, minute, second and millisecond.
786    ///
787    /// The millisecond part is allowed to exceed 1,000 in order to represent a [leap second](
788    /// ./struct.NaiveTime.html#leap-second-handling), but only when `sec == 59`.
789    ///
790    /// # Panics
791    ///
792    /// Panics on invalid hour, minute, second and/or millisecond.
793    #[deprecated(since = "0.4.23", note = "use `and_hms_milli_opt()` instead")]
794    #[inline]
795    #[must_use]
796    pub const fn and_hms_milli(&self, hour: u32, min: u32, sec: u32, milli: u32) -> NaiveDateTime {
797        expect(self.and_hms_milli_opt(hour, min, sec, milli), "invalid time")
798    }
799
800    /// Makes a new `NaiveDateTime` from the current date, hour, minute, second and millisecond.
801    ///
802    /// The millisecond part is allowed to exceed 1,000 in order to represent a [leap second](
803    /// ./struct.NaiveTime.html#leap-second-handling), but only when `sec == 59`.
804    ///
805    /// # Errors
806    ///
807    /// Returns `None` on invalid hour, minute, second and/or millisecond.
808    ///
809    /// # Example
810    ///
811    /// ```
812    /// use chrono::NaiveDate;
813    ///
814    /// let d = NaiveDate::from_ymd_opt(2015, 6, 3).unwrap();
815    /// assert!(d.and_hms_milli_opt(12, 34, 56, 789).is_some());
816    /// assert!(d.and_hms_milli_opt(12, 34, 59, 1_789).is_some()); // leap second
817    /// assert!(d.and_hms_milli_opt(12, 34, 59, 2_789).is_none());
818    /// assert!(d.and_hms_milli_opt(12, 34, 60, 789).is_none());
819    /// assert!(d.and_hms_milli_opt(12, 60, 56, 789).is_none());
820    /// assert!(d.and_hms_milli_opt(24, 34, 56, 789).is_none());
821    /// ```
822    #[inline]
823    #[must_use]
824    pub const fn and_hms_milli_opt(
825        &self,
826        hour: u32,
827        min: u32,
828        sec: u32,
829        milli: u32,
830    ) -> Option<NaiveDateTime> {
831        let time = try_opt!(NaiveTime::from_hms_milli_opt(hour, min, sec, milli));
832        Some(self.and_time(time))
833    }
834
835    /// Makes a new `NaiveDateTime` from the current date, hour, minute, second and microsecond.
836    ///
837    /// The microsecond part is allowed to exceed 1,000,000 in order to represent a [leap second](
838    /// ./struct.NaiveTime.html#leap-second-handling), but only when `sec == 59`.
839    ///
840    /// # Panics
841    ///
842    /// Panics on invalid hour, minute, second and/or microsecond.
843    ///
844    /// # Example
845    ///
846    /// ```
847    /// use chrono::{Datelike, NaiveDate, NaiveDateTime, Timelike, Weekday};
848    ///
849    /// let d = NaiveDate::from_ymd_opt(2015, 6, 3).unwrap();
850    ///
851    /// let dt: NaiveDateTime = d.and_hms_micro_opt(12, 34, 56, 789_012).unwrap();
852    /// assert_eq!(dt.year(), 2015);
853    /// assert_eq!(dt.weekday(), Weekday::Wed);
854    /// assert_eq!(dt.second(), 56);
855    /// assert_eq!(dt.nanosecond(), 789_012_000);
856    /// ```
857    #[deprecated(since = "0.4.23", note = "use `and_hms_micro_opt()` instead")]
858    #[inline]
859    #[must_use]
860    pub const fn and_hms_micro(&self, hour: u32, min: u32, sec: u32, micro: u32) -> NaiveDateTime {
861        expect(self.and_hms_micro_opt(hour, min, sec, micro), "invalid time")
862    }
863
864    /// Makes a new `NaiveDateTime` from the current date, hour, minute, second and microsecond.
865    ///
866    /// The microsecond part is allowed to exceed 1,000,000 in order to represent a [leap second](
867    /// ./struct.NaiveTime.html#leap-second-handling), but only when `sec == 59`.
868    ///
869    /// # Errors
870    ///
871    /// Returns `None` on invalid hour, minute, second and/or microsecond.
872    ///
873    /// # Example
874    ///
875    /// ```
876    /// use chrono::NaiveDate;
877    ///
878    /// let d = NaiveDate::from_ymd_opt(2015, 6, 3).unwrap();
879    /// assert!(d.and_hms_micro_opt(12, 34, 56, 789_012).is_some());
880    /// assert!(d.and_hms_micro_opt(12, 34, 59, 1_789_012).is_some()); // leap second
881    /// assert!(d.and_hms_micro_opt(12, 34, 59, 2_789_012).is_none());
882    /// assert!(d.and_hms_micro_opt(12, 34, 60, 789_012).is_none());
883    /// assert!(d.and_hms_micro_opt(12, 60, 56, 789_012).is_none());
884    /// assert!(d.and_hms_micro_opt(24, 34, 56, 789_012).is_none());
885    /// ```
886    #[inline]
887    #[must_use]
888    pub const fn and_hms_micro_opt(
889        &self,
890        hour: u32,
891        min: u32,
892        sec: u32,
893        micro: u32,
894    ) -> Option<NaiveDateTime> {
895        let time = try_opt!(NaiveTime::from_hms_micro_opt(hour, min, sec, micro));
896        Some(self.and_time(time))
897    }
898
899    /// Makes a new `NaiveDateTime` from the current date, hour, minute, second and nanosecond.
900    ///
901    /// The nanosecond part is allowed to exceed 1,000,000,000 in order to represent a [leap second](
902    /// ./struct.NaiveTime.html#leap-second-handling), but only when `sec == 59`.
903    ///
904    /// # Panics
905    ///
906    /// Panics on invalid hour, minute, second and/or nanosecond.
907    #[deprecated(since = "0.4.23", note = "use `and_hms_nano_opt()` instead")]
908    #[inline]
909    #[must_use]
910    pub const fn and_hms_nano(&self, hour: u32, min: u32, sec: u32, nano: u32) -> NaiveDateTime {
911        expect(self.and_hms_nano_opt(hour, min, sec, nano), "invalid time")
912    }
913
914    /// Makes a new `NaiveDateTime` from the current date, hour, minute, second and nanosecond.
915    ///
916    /// The nanosecond part is allowed to exceed 1,000,000,000 in order to represent a [leap second](
917    /// ./struct.NaiveTime.html#leap-second-handling), but only when `sec == 59`.
918    ///
919    /// # Errors
920    ///
921    /// Returns `None` on invalid hour, minute, second and/or nanosecond.
922    ///
923    /// # Example
924    ///
925    /// ```
926    /// use chrono::NaiveDate;
927    ///
928    /// let d = NaiveDate::from_ymd_opt(2015, 6, 3).unwrap();
929    /// assert!(d.and_hms_nano_opt(12, 34, 56, 789_012_345).is_some());
930    /// assert!(d.and_hms_nano_opt(12, 34, 59, 1_789_012_345).is_some()); // leap second
931    /// assert!(d.and_hms_nano_opt(12, 34, 59, 2_789_012_345).is_none());
932    /// assert!(d.and_hms_nano_opt(12, 34, 60, 789_012_345).is_none());
933    /// assert!(d.and_hms_nano_opt(12, 60, 56, 789_012_345).is_none());
934    /// assert!(d.and_hms_nano_opt(24, 34, 56, 789_012_345).is_none());
935    /// ```
936    #[inline]
937    #[must_use]
938    pub const fn and_hms_nano_opt(
939        &self,
940        hour: u32,
941        min: u32,
942        sec: u32,
943        nano: u32,
944    ) -> Option<NaiveDateTime> {
945        let time = try_opt!(NaiveTime::from_hms_nano_opt(hour, min, sec, nano));
946        Some(self.and_time(time))
947    }
948
949    /// Returns the packed month-day-flags.
950    #[inline]
951    const fn mdf(&self) -> Mdf {
952        Mdf::from_ol((self.yof() & OL_MASK) >> 3, self.year_flags())
953    }
954
955    /// Makes a new `NaiveDate` with the packed month-day-flags changed.
956    ///
957    /// Returns `None` when the resulting `NaiveDate` would be invalid.
958    #[inline]
959    const fn with_mdf(&self, mdf: Mdf) -> Option<NaiveDate> {
960        debug_assert!(self.year_flags().0 == mdf.year_flags().0);
961        match mdf.ordinal() {
962            Some(ordinal) => {
963                Some(NaiveDate::from_yof((self.yof() & !ORDINAL_MASK) | (ordinal << 4) as i32))
964            }
965            None => None, // Non-existing date
966        }
967    }
968
969    /// Makes a new `NaiveDate` for the next calendar date.
970    ///
971    /// # Panics
972    ///
973    /// Panics when `self` is the last representable date.
974    #[deprecated(since = "0.4.23", note = "use `succ_opt()` instead")]
975    #[inline]
976    #[must_use]
977    pub const fn succ(&self) -> NaiveDate {
978        expect(self.succ_opt(), "out of bound")
979    }
980
981    /// Makes a new `NaiveDate` for the next calendar date.
982    ///
983    /// # Errors
984    ///
985    /// Returns `None` when `self` is the last representable date.
986    ///
987    /// # Example
988    ///
989    /// ```
990    /// use chrono::NaiveDate;
991    ///
992    /// assert_eq!(
993    ///     NaiveDate::from_ymd_opt(2015, 6, 3).unwrap().succ_opt(),
994    ///     Some(NaiveDate::from_ymd_opt(2015, 6, 4).unwrap())
995    /// );
996    /// assert_eq!(NaiveDate::MAX.succ_opt(), None);
997    /// ```
998    #[inline]
999    #[must_use]
1000    pub const fn succ_opt(&self) -> Option<NaiveDate> {
1001        let new_ol = (self.yof() & OL_MASK) + (1 << 4);
1002        match new_ol <= MAX_OL {
1003            true => Some(NaiveDate::from_yof(self.yof() & !OL_MASK | new_ol)),
1004            false => NaiveDate::from_yo_opt(self.year() + 1, 1),
1005        }
1006    }
1007
1008    /// Makes a new `NaiveDate` for the previous calendar date.
1009    ///
1010    /// # Panics
1011    ///
1012    /// Panics when `self` is the first representable date.
1013    #[deprecated(since = "0.4.23", note = "use `pred_opt()` instead")]
1014    #[inline]
1015    #[must_use]
1016    pub const fn pred(&self) -> NaiveDate {
1017        expect(self.pred_opt(), "out of bound")
1018    }
1019
1020    /// Makes a new `NaiveDate` for the previous calendar date.
1021    ///
1022    /// # Errors
1023    ///
1024    /// Returns `None` when `self` is the first representable date.
1025    ///
1026    /// # Example
1027    ///
1028    /// ```
1029    /// use chrono::NaiveDate;
1030    ///
1031    /// assert_eq!(
1032    ///     NaiveDate::from_ymd_opt(2015, 6, 3).unwrap().pred_opt(),
1033    ///     Some(NaiveDate::from_ymd_opt(2015, 6, 2).unwrap())
1034    /// );
1035    /// assert_eq!(NaiveDate::MIN.pred_opt(), None);
1036    /// ```
1037    #[inline]
1038    #[must_use]
1039    pub const fn pred_opt(&self) -> Option<NaiveDate> {
1040        let new_shifted_ordinal = (self.yof() & ORDINAL_MASK) - (1 << 4);
1041        match new_shifted_ordinal > 0 {
1042            true => Some(NaiveDate::from_yof(self.yof() & !ORDINAL_MASK | new_shifted_ordinal)),
1043            false => NaiveDate::from_ymd_opt(self.year() - 1, 12, 31),
1044        }
1045    }
1046
1047    /// Adds the number of whole days in the given `TimeDelta` to the current date.
1048    ///
1049    /// # Errors
1050    ///
1051    /// Returns `None` if the resulting date would be out of range.
1052    ///
1053    /// # Example
1054    ///
1055    /// ```
1056    /// use chrono::{NaiveDate, TimeDelta};
1057    ///
1058    /// let d = NaiveDate::from_ymd_opt(2015, 9, 5).unwrap();
1059    /// assert_eq!(
1060    ///     d.checked_add_signed(TimeDelta::try_days(40).unwrap()),
1061    ///     Some(NaiveDate::from_ymd_opt(2015, 10, 15).unwrap())
1062    /// );
1063    /// assert_eq!(
1064    ///     d.checked_add_signed(TimeDelta::try_days(-40).unwrap()),
1065    ///     Some(NaiveDate::from_ymd_opt(2015, 7, 27).unwrap())
1066    /// );
1067    /// assert_eq!(d.checked_add_signed(TimeDelta::try_days(1_000_000_000).unwrap()), None);
1068    /// assert_eq!(d.checked_add_signed(TimeDelta::try_days(-1_000_000_000).unwrap()), None);
1069    /// assert_eq!(NaiveDate::MAX.checked_add_signed(TimeDelta::try_days(1).unwrap()), None);
1070    /// ```
1071    #[must_use]
1072    pub const fn checked_add_signed(self, rhs: TimeDelta) -> Option<NaiveDate> {
1073        let days = rhs.num_days();
1074        if days < i32::MIN as i64 || days > i32::MAX as i64 {
1075            return None;
1076        }
1077        self.add_days(days as i32)
1078    }
1079
1080    /// Subtracts the number of whole days in the given `TimeDelta` from the current date.
1081    ///
1082    /// # Errors
1083    ///
1084    /// Returns `None` if the resulting date would be out of range.
1085    ///
1086    /// # Example
1087    ///
1088    /// ```
1089    /// use chrono::{NaiveDate, TimeDelta};
1090    ///
1091    /// let d = NaiveDate::from_ymd_opt(2015, 9, 5).unwrap();
1092    /// assert_eq!(
1093    ///     d.checked_sub_signed(TimeDelta::try_days(40).unwrap()),
1094    ///     Some(NaiveDate::from_ymd_opt(2015, 7, 27).unwrap())
1095    /// );
1096    /// assert_eq!(
1097    ///     d.checked_sub_signed(TimeDelta::try_days(-40).unwrap()),
1098    ///     Some(NaiveDate::from_ymd_opt(2015, 10, 15).unwrap())
1099    /// );
1100    /// assert_eq!(d.checked_sub_signed(TimeDelta::try_days(1_000_000_000).unwrap()), None);
1101    /// assert_eq!(d.checked_sub_signed(TimeDelta::try_days(-1_000_000_000).unwrap()), None);
1102    /// assert_eq!(NaiveDate::MIN.checked_sub_signed(TimeDelta::try_days(1).unwrap()), None);
1103    /// ```
1104    #[must_use]
1105    pub const fn checked_sub_signed(self, rhs: TimeDelta) -> Option<NaiveDate> {
1106        let days = -rhs.num_days();
1107        if days < i32::MIN as i64 || days > i32::MAX as i64 {
1108            return None;
1109        }
1110        self.add_days(days as i32)
1111    }
1112
1113    /// Subtracts another `NaiveDate` from the current date.
1114    /// Returns a `TimeDelta` of integral numbers.
1115    ///
1116    /// This does not overflow or underflow at all,
1117    /// as all possible output fits in the range of `TimeDelta`.
1118    ///
1119    /// # Example
1120    ///
1121    /// ```
1122    /// use chrono::{NaiveDate, TimeDelta};
1123    ///
1124    /// let from_ymd = |y, m, d| NaiveDate::from_ymd_opt(y, m, d).unwrap();
1125    /// let since = NaiveDate::signed_duration_since;
1126    ///
1127    /// assert_eq!(since(from_ymd(2014, 1, 1), from_ymd(2014, 1, 1)), TimeDelta::zero());
1128    /// assert_eq!(
1129    ///     since(from_ymd(2014, 1, 1), from_ymd(2013, 12, 31)),
1130    ///     TimeDelta::try_days(1).unwrap()
1131    /// );
1132    /// assert_eq!(since(from_ymd(2014, 1, 1), from_ymd(2014, 1, 2)), TimeDelta::try_days(-1).unwrap());
1133    /// assert_eq!(
1134    ///     since(from_ymd(2014, 1, 1), from_ymd(2013, 9, 23)),
1135    ///     TimeDelta::try_days(100).unwrap()
1136    /// );
1137    /// assert_eq!(
1138    ///     since(from_ymd(2014, 1, 1), from_ymd(2013, 1, 1)),
1139    ///     TimeDelta::try_days(365).unwrap()
1140    /// );
1141    /// assert_eq!(
1142    ///     since(from_ymd(2014, 1, 1), from_ymd(2010, 1, 1)),
1143    ///     TimeDelta::try_days(365 * 4 + 1).unwrap()
1144    /// );
1145    /// assert_eq!(
1146    ///     since(from_ymd(2014, 1, 1), from_ymd(1614, 1, 1)),
1147    ///     TimeDelta::try_days(365 * 400 + 97).unwrap()
1148    /// );
1149    /// ```
1150    #[must_use]
1151    pub const fn signed_duration_since(self, rhs: NaiveDate) -> TimeDelta {
1152        let year1 = self.year();
1153        let year2 = rhs.year();
1154        let (year1_div_400, year1_mod_400) = div_mod_floor(year1, 400);
1155        let (year2_div_400, year2_mod_400) = div_mod_floor(year2, 400);
1156        let cycle1 = yo_to_cycle(year1_mod_400 as u32, self.ordinal()) as i64;
1157        let cycle2 = yo_to_cycle(year2_mod_400 as u32, rhs.ordinal()) as i64;
1158        let days = (year1_div_400 as i64 - year2_div_400 as i64) * 146_097 + (cycle1 - cycle2);
1159        // The range of `TimeDelta` is ca. 585 million years, the range of `NaiveDate` ca. 525.000
1160        // years.
1161        expect(TimeDelta::try_days(days), "always in range")
1162    }
1163
1164    /// Returns the number of whole years from the given `base` until `self`.
1165    ///
1166    /// # Errors
1167    ///
1168    /// Returns `None` if `base > self`.
1169    #[must_use]
1170    pub const fn years_since(&self, base: Self) -> Option<u32> {
1171        let mut years = self.year() - base.year();
1172        // Comparing tuples is not (yet) possible in const context. Instead we combine month and
1173        // day into one `u32` for easy comparison.
1174        if ((self.month() << 5) | self.day()) < ((base.month() << 5) | base.day()) {
1175            years -= 1;
1176        }
1177
1178        match years >= 0 {
1179            true => Some(years as u32),
1180            false => None,
1181        }
1182    }
1183
1184    /// Formats the date with the specified formatting items.
1185    /// Otherwise it is the same as the ordinary `format` method.
1186    ///
1187    /// The `Iterator` of items should be `Clone`able,
1188    /// since the resulting `DelayedFormat` value may be formatted multiple times.
1189    ///
1190    /// # Example
1191    ///
1192    /// ```
1193    /// use chrono::format::strftime::StrftimeItems;
1194    /// use chrono::NaiveDate;
1195    ///
1196    /// let fmt = StrftimeItems::new("%Y-%m-%d");
1197    /// let d = NaiveDate::from_ymd_opt(2015, 9, 5).unwrap();
1198    /// assert_eq!(d.format_with_items(fmt.clone()).to_string(), "2015-09-05");
1199    /// assert_eq!(d.format("%Y-%m-%d").to_string(), "2015-09-05");
1200    /// ```
1201    ///
1202    /// The resulting `DelayedFormat` can be formatted directly via the `Display` trait.
1203    ///
1204    /// ```
1205    /// # use chrono::NaiveDate;
1206    /// # use chrono::format::strftime::StrftimeItems;
1207    /// # let fmt = StrftimeItems::new("%Y-%m-%d").clone();
1208    /// # let d = NaiveDate::from_ymd_opt(2015, 9, 5).unwrap();
1209    /// assert_eq!(format!("{}", d.format_with_items(fmt)), "2015-09-05");
1210    /// ```
1211    #[cfg(feature = "alloc")]
1212    #[inline]
1213    #[must_use]
1214    pub fn format_with_items<'a, I, B>(&self, items: I) -> DelayedFormat<I>
1215    where
1216        I: Iterator<Item = B> + Clone,
1217        B: Borrow<Item<'a>>,
1218    {
1219        DelayedFormat::new(Some(*self), None, items)
1220    }
1221
1222    /// Formats the date with the specified format string.
1223    /// See the [`format::strftime` module](crate::format::strftime)
1224    /// on the supported escape sequences.
1225    ///
1226    /// This returns a `DelayedFormat`,
1227    /// which gets converted to a string only when actual formatting happens.
1228    /// You may use the `to_string` method to get a `String`,
1229    /// or just feed it into `print!` and other formatting macros.
1230    /// (In this way it avoids the redundant memory allocation.)
1231    ///
1232    /// # Panics
1233    ///
1234    /// Converting or formatting the returned `DelayedFormat` panics if the format string is wrong.
1235    /// Because of this delayed failure, you are recommended to immediately use the `DelayedFormat`
1236    /// value.
1237    ///
1238    /// # Example
1239    ///
1240    /// ```
1241    /// use chrono::NaiveDate;
1242    ///
1243    /// let d = NaiveDate::from_ymd_opt(2015, 9, 5).unwrap();
1244    /// assert_eq!(d.format("%Y-%m-%d").to_string(), "2015-09-05");
1245    /// assert_eq!(d.format("%A, %-d %B, %C%y").to_string(), "Saturday, 5 September, 2015");
1246    /// ```
1247    ///
1248    /// The resulting `DelayedFormat` can be formatted directly via the `Display` trait.
1249    ///
1250    /// ```
1251    /// # use chrono::NaiveDate;
1252    /// # let d = NaiveDate::from_ymd_opt(2015, 9, 5).unwrap();
1253    /// assert_eq!(format!("{}", d.format("%Y-%m-%d")), "2015-09-05");
1254    /// assert_eq!(format!("{}", d.format("%A, %-d %B, %C%y")), "Saturday, 5 September, 2015");
1255    /// ```
1256    #[cfg(feature = "alloc")]
1257    #[inline]
1258    #[must_use]
1259    pub fn format<'a>(&self, fmt: &'a str) -> DelayedFormat<StrftimeItems<'a>> {
1260        self.format_with_items(StrftimeItems::new(fmt))
1261    }
1262
1263    /// Formats the date with the specified formatting items and locale.
1264    #[cfg(all(feature = "unstable-locales", feature = "alloc"))]
1265    #[inline]
1266    #[must_use]
1267    pub fn format_localized_with_items<'a, I, B>(
1268        &self,
1269        items: I,
1270        locale: Locale,
1271    ) -> DelayedFormat<I>
1272    where
1273        I: Iterator<Item = B> + Clone,
1274        B: Borrow<Item<'a>>,
1275    {
1276        DelayedFormat::new_with_locale(Some(*self), None, items, locale)
1277    }
1278
1279    /// Formats the date with the specified format string and locale.
1280    ///
1281    /// See the [`crate::format::strftime`] module on the supported escape
1282    /// sequences.
1283    #[cfg(all(feature = "unstable-locales", feature = "alloc"))]
1284    #[inline]
1285    #[must_use]
1286    pub fn format_localized<'a>(
1287        &self,
1288        fmt: &'a str,
1289        locale: Locale,
1290    ) -> DelayedFormat<StrftimeItems<'a>> {
1291        self.format_localized_with_items(StrftimeItems::new_with_locale(fmt, locale), locale)
1292    }
1293
1294    /// Returns an iterator that steps by days across all representable dates.
1295    ///
1296    /// # Example
1297    ///
1298    /// ```
1299    /// # use chrono::NaiveDate;
1300    ///
1301    /// let expected = [
1302    ///     NaiveDate::from_ymd_opt(2016, 2, 27).unwrap(),
1303    ///     NaiveDate::from_ymd_opt(2016, 2, 28).unwrap(),
1304    ///     NaiveDate::from_ymd_opt(2016, 2, 29).unwrap(),
1305    ///     NaiveDate::from_ymd_opt(2016, 3, 1).unwrap(),
1306    /// ];
1307    ///
1308    /// let mut count = 0;
1309    /// for (idx, d) in NaiveDate::from_ymd_opt(2016, 2, 27).unwrap().iter_days().take(4).enumerate() {
1310    ///     assert_eq!(d, expected[idx]);
1311    ///     count += 1;
1312    /// }
1313    /// assert_eq!(count, 4);
1314    ///
1315    /// for d in NaiveDate::from_ymd_opt(2016, 3, 1).unwrap().iter_days().rev().take(4) {
1316    ///     count -= 1;
1317    ///     assert_eq!(d, expected[count]);
1318    /// }
1319    /// ```
1320    #[inline]
1321    pub const fn iter_days(&self) -> NaiveDateDaysIterator {
1322        NaiveDateDaysIterator { value: *self }
1323    }
1324
1325    /// Returns an iterator that steps by weeks across all representable dates.
1326    ///
1327    /// # Example
1328    ///
1329    /// ```
1330    /// # use chrono::NaiveDate;
1331    ///
1332    /// let expected = [
1333    ///     NaiveDate::from_ymd_opt(2016, 2, 27).unwrap(),
1334    ///     NaiveDate::from_ymd_opt(2016, 3, 5).unwrap(),
1335    ///     NaiveDate::from_ymd_opt(2016, 3, 12).unwrap(),
1336    ///     NaiveDate::from_ymd_opt(2016, 3, 19).unwrap(),
1337    /// ];
1338    ///
1339    /// let mut count = 0;
1340    /// for (idx, d) in NaiveDate::from_ymd_opt(2016, 2, 27).unwrap().iter_weeks().take(4).enumerate() {
1341    ///     assert_eq!(d, expected[idx]);
1342    ///     count += 1;
1343    /// }
1344    /// assert_eq!(count, 4);
1345    ///
1346    /// for d in NaiveDate::from_ymd_opt(2016, 3, 19).unwrap().iter_weeks().rev().take(4) {
1347    ///     count -= 1;
1348    ///     assert_eq!(d, expected[count]);
1349    /// }
1350    /// ```
1351    #[inline]
1352    pub const fn iter_weeks(&self) -> NaiveDateWeeksIterator {
1353        NaiveDateWeeksIterator { value: *self }
1354    }
1355
1356    /// Returns the [`NaiveWeek`] that the date belongs to, starting with the [`Weekday`]
1357    /// specified.
1358    #[inline]
1359    pub const fn week(&self, start: Weekday) -> NaiveWeek {
1360        NaiveWeek::new(*self, start)
1361    }
1362
1363    /// Returns `true` if this is a leap year.
1364    ///
1365    /// ```
1366    /// # use chrono::NaiveDate;
1367    /// assert_eq!(NaiveDate::from_ymd_opt(2000, 1, 1).unwrap().leap_year(), true);
1368    /// assert_eq!(NaiveDate::from_ymd_opt(2001, 1, 1).unwrap().leap_year(), false);
1369    /// assert_eq!(NaiveDate::from_ymd_opt(2002, 1, 1).unwrap().leap_year(), false);
1370    /// assert_eq!(NaiveDate::from_ymd_opt(2003, 1, 1).unwrap().leap_year(), false);
1371    /// assert_eq!(NaiveDate::from_ymd_opt(2004, 1, 1).unwrap().leap_year(), true);
1372    /// assert_eq!(NaiveDate::from_ymd_opt(2100, 1, 1).unwrap().leap_year(), false);
1373    /// ```
1374    pub const fn leap_year(&self) -> bool {
1375        self.yof() & (0b1000) == 0
1376    }
1377
1378    // This duplicates `Datelike::year()`, because trait methods can't be const yet.
1379    #[inline]
1380    const fn year(&self) -> i32 {
1381        self.yof() >> 13
1382    }
1383
1384    /// Returns the day of year starting from 1.
1385    // This duplicates `Datelike::ordinal()`, because trait methods can't be const yet.
1386    #[inline]
1387    const fn ordinal(&self) -> u32 {
1388        ((self.yof() & ORDINAL_MASK) >> 4) as u32
1389    }
1390
1391    // This duplicates `Datelike::month()`, because trait methods can't be const yet.
1392    #[inline]
1393    const fn month(&self) -> u32 {
1394        self.mdf().month()
1395    }
1396
1397    // This duplicates `Datelike::day()`, because trait methods can't be const yet.
1398    #[inline]
1399    const fn day(&self) -> u32 {
1400        self.mdf().day()
1401    }
1402
1403    /// Returns the day of week.
1404    // This duplicates `Datelike::weekday()`, because trait methods can't be const yet.
1405    #[inline]
1406    pub(super) const fn weekday(&self) -> Weekday {
1407        match (((self.yof() & ORDINAL_MASK) >> 4) + (self.yof() & WEEKDAY_FLAGS_MASK)) % 7 {
1408            0 => Weekday::Mon,
1409            1 => Weekday::Tue,
1410            2 => Weekday::Wed,
1411            3 => Weekday::Thu,
1412            4 => Weekday::Fri,
1413            5 => Weekday::Sat,
1414            _ => Weekday::Sun,
1415        }
1416    }
1417
1418    #[inline]
1419    const fn year_flags(&self) -> YearFlags {
1420        YearFlags((self.yof() & YEAR_FLAGS_MASK) as u8)
1421    }
1422
1423    /// Counts the days in the proleptic Gregorian calendar, with January 1, Year 1 (CE) as day 1.
1424    // This duplicates `Datelike::num_days_from_ce()`, because trait methods can't be const yet.
1425    pub(crate) const fn num_days_from_ce(&self) -> i32 {
1426        // we know this wouldn't overflow since year is limited to 1/2^13 of i32's full range.
1427        let mut year = self.year() - 1;
1428        let mut ndays = 0;
1429        if year < 0 {
1430            let excess = 1 + (-year) / 400;
1431            year += excess * 400;
1432            ndays -= excess * 146_097;
1433        }
1434        let div_100 = year / 100;
1435        ndays += ((year * 1461) >> 2) - div_100 + (div_100 >> 2);
1436        ndays + self.ordinal() as i32
1437    }
1438
1439    /// Counts the days in the proleptic Gregorian calendar, with January 1, Year 1970 as day 0.
1440    ///
1441    /// # Example
1442    ///
1443    /// ```
1444    /// use chrono::NaiveDate;
1445    ///
1446    /// let from_ymd = |y, m, d| NaiveDate::from_ymd_opt(y, m, d).unwrap();
1447    ///
1448    /// assert_eq!(from_ymd(1, 1, 1).to_epoch_days(), -719162);
1449    /// assert_eq!(from_ymd(1970, 1, 1).to_epoch_days(), 0);
1450    /// assert_eq!(from_ymd(2005, 9, 10).to_epoch_days(), 13036);
1451    /// ```
1452    pub const fn to_epoch_days(&self) -> i32 {
1453        self.num_days_from_ce() - UNIX_EPOCH_DAY as i32
1454    }
1455
1456    /// Create a new `NaiveDate` from a raw year-ordinal-flags `i32`.
1457    ///
1458    /// In a valid value an ordinal is never `0`, and neither are the year flags. This method
1459    /// doesn't do any validation in release builds.
1460    #[inline]
1461    const fn from_yof(yof: i32) -> NaiveDate {
1462        // The following are the invariants our ordinal and flags should uphold for a valid
1463        // `NaiveDate`.
1464        debug_assert!(((yof & OL_MASK) >> 3) > 1);
1465        debug_assert!(((yof & OL_MASK) >> 3) <= MAX_OL);
1466        debug_assert!((yof & 0b111) != 000);
1467        NaiveDate { yof: unsafe { NonZeroI32::new_unchecked(yof) } }
1468    }
1469
1470    /// Get the raw year-ordinal-flags `i32`.
1471    #[inline]
1472    const fn yof(&self) -> i32 {
1473        self.yof.get()
1474    }
1475
1476    /// The minimum possible `NaiveDate` (January 1, 262144 BCE).
1477    pub const MIN: NaiveDate = NaiveDate::from_yof((MIN_YEAR << 13) | (1 << 4) | 0o12 /* D */);
1478    /// The maximum possible `NaiveDate` (December 31, 262142 CE).
1479    pub const MAX: NaiveDate =
1480        NaiveDate::from_yof((MAX_YEAR << 13) | (365 << 4) | 0o16 /* G */);
1481
1482    /// One day before the minimum possible `NaiveDate` (December 31, 262145 BCE).
1483    pub(crate) const BEFORE_MIN: NaiveDate =
1484        NaiveDate::from_yof(((MIN_YEAR - 1) << 13) | (366 << 4) | 0o07 /* FE */);
1485    /// One day after the maximum possible `NaiveDate` (January 1, 262143 CE).
1486    pub(crate) const AFTER_MAX: NaiveDate =
1487        NaiveDate::from_yof(((MAX_YEAR + 1) << 13) | (1 << 4) | 0o17 /* F */);
1488}
1489
1490impl Datelike for NaiveDate {
1491    /// Returns the year number in the [calendar date](#calendar-date).
1492    ///
1493    /// # Example
1494    ///
1495    /// ```
1496    /// use chrono::{Datelike, NaiveDate};
1497    ///
1498    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().year(), 2015);
1499    /// assert_eq!(NaiveDate::from_ymd_opt(-308, 3, 14).unwrap().year(), -308); // 309 BCE
1500    /// ```
1501    #[inline]
1502    fn year(&self) -> i32 {
1503        self.year()
1504    }
1505
1506    /// Returns the month number starting from 1.
1507    ///
1508    /// The return value ranges from 1 to 12.
1509    ///
1510    /// # Example
1511    ///
1512    /// ```
1513    /// use chrono::{Datelike, NaiveDate};
1514    ///
1515    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().month(), 9);
1516    /// assert_eq!(NaiveDate::from_ymd_opt(-308, 3, 14).unwrap().month(), 3);
1517    /// ```
1518    #[inline]
1519    fn month(&self) -> u32 {
1520        self.month()
1521    }
1522
1523    /// Returns the month number starting from 0.
1524    ///
1525    /// The return value ranges from 0 to 11.
1526    ///
1527    /// # Example
1528    ///
1529    /// ```
1530    /// use chrono::{Datelike, NaiveDate};
1531    ///
1532    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().month0(), 8);
1533    /// assert_eq!(NaiveDate::from_ymd_opt(-308, 3, 14).unwrap().month0(), 2);
1534    /// ```
1535    #[inline]
1536    fn month0(&self) -> u32 {
1537        self.month() - 1
1538    }
1539
1540    /// Returns the day of month starting from 1.
1541    ///
1542    /// The return value ranges from 1 to 31. (The last day of month differs by months.)
1543    ///
1544    /// # Example
1545    ///
1546    /// ```
1547    /// use chrono::{Datelike, NaiveDate};
1548    ///
1549    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().day(), 8);
1550    /// assert_eq!(NaiveDate::from_ymd_opt(-308, 3, 14).unwrap().day(), 14);
1551    /// ```
1552    ///
1553    /// Combined with [`NaiveDate::pred_opt`](#method.pred_opt),
1554    /// one can determine the number of days in a particular month.
1555    /// (Note that this panics when `year` is out of range.)
1556    ///
1557    /// ```
1558    /// use chrono::{Datelike, NaiveDate};
1559    ///
1560    /// fn ndays_in_month(year: i32, month: u32) -> u32 {
1561    ///     // the first day of the next month...
1562    ///     let (y, m) = if month == 12 { (year + 1, 1) } else { (year, month + 1) };
1563    ///     let d = NaiveDate::from_ymd_opt(y, m, 1).unwrap();
1564    ///
1565    ///     // ...is preceded by the last day of the original month
1566    ///     d.pred_opt().unwrap().day()
1567    /// }
1568    ///
1569    /// assert_eq!(ndays_in_month(2015, 8), 31);
1570    /// assert_eq!(ndays_in_month(2015, 9), 30);
1571    /// assert_eq!(ndays_in_month(2015, 12), 31);
1572    /// assert_eq!(ndays_in_month(2016, 2), 29);
1573    /// assert_eq!(ndays_in_month(2017, 2), 28);
1574    /// ```
1575    #[inline]
1576    fn day(&self) -> u32 {
1577        self.day()
1578    }
1579
1580    /// Returns the day of month starting from 0.
1581    ///
1582    /// The return value ranges from 0 to 30. (The last day of month differs by months.)
1583    ///
1584    /// # Example
1585    ///
1586    /// ```
1587    /// use chrono::{Datelike, NaiveDate};
1588    ///
1589    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().day0(), 7);
1590    /// assert_eq!(NaiveDate::from_ymd_opt(-308, 3, 14).unwrap().day0(), 13);
1591    /// ```
1592    #[inline]
1593    fn day0(&self) -> u32 {
1594        self.mdf().day() - 1
1595    }
1596
1597    /// Returns the day of year starting from 1.
1598    ///
1599    /// The return value ranges from 1 to 366. (The last day of year differs by years.)
1600    ///
1601    /// # Example
1602    ///
1603    /// ```
1604    /// use chrono::{Datelike, NaiveDate};
1605    ///
1606    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().ordinal(), 251);
1607    /// assert_eq!(NaiveDate::from_ymd_opt(-308, 3, 14).unwrap().ordinal(), 74);
1608    /// ```
1609    ///
1610    /// Combined with [`NaiveDate::pred_opt`](#method.pred_opt),
1611    /// one can determine the number of days in a particular year.
1612    /// (Note that this panics when `year` is out of range.)
1613    ///
1614    /// ```
1615    /// use chrono::{Datelike, NaiveDate};
1616    ///
1617    /// fn ndays_in_year(year: i32) -> u32 {
1618    ///     // the first day of the next year...
1619    ///     let d = NaiveDate::from_ymd_opt(year + 1, 1, 1).unwrap();
1620    ///
1621    ///     // ...is preceded by the last day of the original year
1622    ///     d.pred_opt().unwrap().ordinal()
1623    /// }
1624    ///
1625    /// assert_eq!(ndays_in_year(2015), 365);
1626    /// assert_eq!(ndays_in_year(2016), 366);
1627    /// assert_eq!(ndays_in_year(2017), 365);
1628    /// assert_eq!(ndays_in_year(2000), 366);
1629    /// assert_eq!(ndays_in_year(2100), 365);
1630    /// ```
1631    #[inline]
1632    fn ordinal(&self) -> u32 {
1633        ((self.yof() & ORDINAL_MASK) >> 4) as u32
1634    }
1635
1636    /// Returns the day of year starting from 0.
1637    ///
1638    /// The return value ranges from 0 to 365. (The last day of year differs by years.)
1639    ///
1640    /// # Example
1641    ///
1642    /// ```
1643    /// use chrono::{Datelike, NaiveDate};
1644    ///
1645    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().ordinal0(), 250);
1646    /// assert_eq!(NaiveDate::from_ymd_opt(-308, 3, 14).unwrap().ordinal0(), 73);
1647    /// ```
1648    #[inline]
1649    fn ordinal0(&self) -> u32 {
1650        self.ordinal() - 1
1651    }
1652
1653    /// Returns the day of week.
1654    ///
1655    /// # Example
1656    ///
1657    /// ```
1658    /// use chrono::{Datelike, NaiveDate, Weekday};
1659    ///
1660    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().weekday(), Weekday::Tue);
1661    /// assert_eq!(NaiveDate::from_ymd_opt(-308, 3, 14).unwrap().weekday(), Weekday::Fri);
1662    /// ```
1663    #[inline]
1664    fn weekday(&self) -> Weekday {
1665        self.weekday()
1666    }
1667
1668    #[inline]
1669    fn iso_week(&self) -> IsoWeek {
1670        IsoWeek::from_yof(self.year(), self.ordinal(), self.year_flags())
1671    }
1672
1673    /// Makes a new `NaiveDate` with the year number changed, while keeping the same month and day.
1674    ///
1675    /// This method assumes you want to work on the date as a year-month-day value. Don't use it if
1676    /// you want the ordinal to stay the same after changing the year, of if you want the week and
1677    /// weekday values to stay the same.
1678    ///
1679    /// # Errors
1680    ///
1681    /// Returns `None` if:
1682    /// - The resulting date does not exist (February 29 in a non-leap year).
1683    /// - The year is out of range for a `NaiveDate`.
1684    ///
1685    /// # Examples
1686    ///
1687    /// ```
1688    /// use chrono::{Datelike, NaiveDate};
1689    ///
1690    /// assert_eq!(
1691    ///     NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().with_year(2016),
1692    ///     Some(NaiveDate::from_ymd_opt(2016, 9, 8).unwrap())
1693    /// );
1694    /// assert_eq!(
1695    ///     NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().with_year(-308),
1696    ///     Some(NaiveDate::from_ymd_opt(-308, 9, 8).unwrap())
1697    /// );
1698    /// ```
1699    ///
1700    /// A leap day (February 29) is a case where this method can return `None`.
1701    ///
1702    /// ```
1703    /// # use chrono::{NaiveDate, Datelike};
1704    /// assert!(NaiveDate::from_ymd_opt(2016, 2, 29).unwrap().with_year(2015).is_none());
1705    /// assert!(NaiveDate::from_ymd_opt(2016, 2, 29).unwrap().with_year(2020).is_some());
1706    /// ```
1707    ///
1708    /// Don't use `with_year` if you want the ordinal date to stay the same:
1709    ///
1710    /// ```
1711    /// # use chrono::{Datelike, NaiveDate};
1712    /// assert_ne!(
1713    ///     NaiveDate::from_yo_opt(2020, 100).unwrap().with_year(2023).unwrap(),
1714    ///     NaiveDate::from_yo_opt(2023, 100).unwrap() // result is 2023-101
1715    /// );
1716    /// ```
1717    #[inline]
1718    fn with_year(&self, year: i32) -> Option<NaiveDate> {
1719        // we need to operate with `mdf` since we should keep the month and day number as is
1720        let mdf = self.mdf();
1721
1722        // adjust the flags as needed
1723        let flags = YearFlags::from_year(year);
1724        let mdf = mdf.with_flags(flags);
1725
1726        NaiveDate::from_mdf(year, mdf)
1727    }
1728
1729    /// Makes a new `NaiveDate` with the month number (starting from 1) changed.
1730    ///
1731    /// # Errors
1732    ///
1733    /// Returns `None` if:
1734    /// - The resulting date does not exist (for example `month(4)` when day of the month is 31).
1735    /// - The value for `month` is invalid.
1736    ///
1737    /// # Examples
1738    ///
1739    /// ```
1740    /// use chrono::{Datelike, NaiveDate};
1741    ///
1742    /// assert_eq!(
1743    ///     NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().with_month(10),
1744    ///     Some(NaiveDate::from_ymd_opt(2015, 10, 8).unwrap())
1745    /// );
1746    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().with_month(13), None); // No month 13
1747    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 30).unwrap().with_month(2), None); // No Feb 30
1748    /// ```
1749    ///
1750    /// Don't combine multiple `Datelike::with_*` methods. The intermediate value may not exist.
1751    ///
1752    /// ```
1753    /// use chrono::{Datelike, NaiveDate};
1754    ///
1755    /// fn with_year_month(date: NaiveDate, year: i32, month: u32) -> Option<NaiveDate> {
1756    ///     date.with_year(year)?.with_month(month)
1757    /// }
1758    /// let d = NaiveDate::from_ymd_opt(2020, 2, 29).unwrap();
1759    /// assert!(with_year_month(d, 2019, 1).is_none()); // fails because of invalid intermediate value
1760    ///
1761    /// // Correct version:
1762    /// fn with_year_month_fixed(date: NaiveDate, year: i32, month: u32) -> Option<NaiveDate> {
1763    ///     NaiveDate::from_ymd_opt(year, month, date.day())
1764    /// }
1765    /// let d = NaiveDate::from_ymd_opt(2020, 2, 29).unwrap();
1766    /// assert_eq!(with_year_month_fixed(d, 2019, 1), NaiveDate::from_ymd_opt(2019, 1, 29));
1767    /// ```
1768    #[inline]
1769    fn with_month(&self, month: u32) -> Option<NaiveDate> {
1770        self.with_mdf(self.mdf().with_month(month)?)
1771    }
1772
1773    /// Makes a new `NaiveDate` with the month number (starting from 0) changed.
1774    ///
1775    /// # Errors
1776    ///
1777    /// Returns `None` if:
1778    /// - The resulting date does not exist (for example `month0(3)` when day of the month is 31).
1779    /// - The value for `month0` is invalid.
1780    ///
1781    /// # Example
1782    ///
1783    /// ```
1784    /// use chrono::{Datelike, NaiveDate};
1785    ///
1786    /// assert_eq!(
1787    ///     NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().with_month0(9),
1788    ///     Some(NaiveDate::from_ymd_opt(2015, 10, 8).unwrap())
1789    /// );
1790    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().with_month0(12), None); // No month 12
1791    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 30).unwrap().with_month0(1), None); // No Feb 30
1792    /// ```
1793    #[inline]
1794    fn with_month0(&self, month0: u32) -> Option<NaiveDate> {
1795        let month = month0.checked_add(1)?;
1796        self.with_mdf(self.mdf().with_month(month)?)
1797    }
1798
1799    /// Makes a new `NaiveDate` with the day of month (starting from 1) changed.
1800    ///
1801    /// # Errors
1802    ///
1803    /// Returns `None` if:
1804    /// - The resulting date does not exist (for example `day(31)` in April).
1805    /// - The value for `day` is invalid.
1806    ///
1807    /// # Example
1808    ///
1809    /// ```
1810    /// use chrono::{Datelike, NaiveDate};
1811    ///
1812    /// assert_eq!(
1813    ///     NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().with_day(30),
1814    ///     Some(NaiveDate::from_ymd_opt(2015, 9, 30).unwrap())
1815    /// );
1816    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().with_day(31), None);
1817    /// // no September 31
1818    /// ```
1819    #[inline]
1820    fn with_day(&self, day: u32) -> Option<NaiveDate> {
1821        self.with_mdf(self.mdf().with_day(day)?)
1822    }
1823
1824    /// Makes a new `NaiveDate` with the day of month (starting from 0) changed.
1825    ///
1826    /// # Errors
1827    ///
1828    /// Returns `None` if:
1829    /// - The resulting date does not exist (for example `day(30)` in April).
1830    /// - The value for `day0` is invalid.
1831    ///
1832    /// # Example
1833    ///
1834    /// ```
1835    /// use chrono::{Datelike, NaiveDate};
1836    ///
1837    /// assert_eq!(
1838    ///     NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().with_day0(29),
1839    ///     Some(NaiveDate::from_ymd_opt(2015, 9, 30).unwrap())
1840    /// );
1841    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().with_day0(30), None);
1842    /// // no September 31
1843    /// ```
1844    #[inline]
1845    fn with_day0(&self, day0: u32) -> Option<NaiveDate> {
1846        let day = day0.checked_add(1)?;
1847        self.with_mdf(self.mdf().with_day(day)?)
1848    }
1849
1850    /// Makes a new `NaiveDate` with the day of year (starting from 1) changed.
1851    ///
1852    /// # Errors
1853    ///
1854    /// Returns `None` if:
1855    /// - The resulting date does not exist (`with_ordinal(366)` in a non-leap year).
1856    /// - The value for `ordinal` is invalid.
1857    ///
1858    /// # Example
1859    ///
1860    /// ```
1861    /// use chrono::{NaiveDate, Datelike};
1862    ///
1863    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 1, 1).unwrap().with_ordinal(60),
1864    ///            Some(NaiveDate::from_ymd_opt(2015, 3, 1).unwrap()));
1865    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 1, 1).unwrap().with_ordinal(366),
1866    ///            None); // 2015 had only 365 days
1867    ///
1868    /// assert_eq!(NaiveDate::from_ymd_opt(2016, 1, 1).unwrap().with_ordinal(60),
1869    ///            Some(NaiveDate::from_ymd_opt(2016, 2, 29).unwrap()));
1870    /// assert_eq!(NaiveDate::from_ymd_opt(2016, 1, 1).unwrap().with_ordinal(366),
1871    ///            Some(NaiveDate::from_ymd_opt(2016, 12, 31).unwrap()));
1872    /// ```
1873    #[inline]
1874    fn with_ordinal(&self, ordinal: u32) -> Option<NaiveDate> {
1875        if ordinal == 0 || ordinal > 366 {
1876            return None;
1877        }
1878        let yof = (self.yof() & !ORDINAL_MASK) | (ordinal << 4) as i32;
1879        match yof & OL_MASK <= MAX_OL {
1880            true => Some(NaiveDate::from_yof(yof)),
1881            false => None, // Does not exist: Ordinal 366 in a common year.
1882        }
1883    }
1884
1885    /// Makes a new `NaiveDate` with the day of year (starting from 0) changed.
1886    ///
1887    /// # Errors
1888    ///
1889    /// Returns `None` if:
1890    /// - The resulting date does not exist (`with_ordinal0(365)` in a non-leap year).
1891    /// - The value for `ordinal0` is invalid.
1892    ///
1893    /// # Example
1894    ///
1895    /// ```
1896    /// use chrono::{NaiveDate, Datelike};
1897    ///
1898    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 1, 1).unwrap().with_ordinal0(59),
1899    ///            Some(NaiveDate::from_ymd_opt(2015, 3, 1).unwrap()));
1900    /// assert_eq!(NaiveDate::from_ymd_opt(2015, 1, 1).unwrap().with_ordinal0(365),
1901    ///            None); // 2015 had only 365 days
1902    ///
1903    /// assert_eq!(NaiveDate::from_ymd_opt(2016, 1, 1).unwrap().with_ordinal0(59),
1904    ///            Some(NaiveDate::from_ymd_opt(2016, 2, 29).unwrap()));
1905    /// assert_eq!(NaiveDate::from_ymd_opt(2016, 1, 1).unwrap().with_ordinal0(365),
1906    ///            Some(NaiveDate::from_ymd_opt(2016, 12, 31).unwrap()));
1907    /// ```
1908    #[inline]
1909    fn with_ordinal0(&self, ordinal0: u32) -> Option<NaiveDate> {
1910        let ordinal = ordinal0.checked_add(1)?;
1911        self.with_ordinal(ordinal)
1912    }
1913}
1914
1915/// Add `TimeDelta` to `NaiveDate`.
1916///
1917/// This discards the fractional days in `TimeDelta`, rounding to the closest integral number of
1918/// days towards `TimeDelta::zero()`.
1919///
1920/// # Panics
1921///
1922/// Panics if the resulting date would be out of range.
1923/// Consider using [`NaiveDate::checked_add_signed`] to get an `Option` instead.
1924///
1925/// # Example
1926///
1927/// ```
1928/// use chrono::{NaiveDate, TimeDelta};
1929///
1930/// let from_ymd = |y, m, d| NaiveDate::from_ymd_opt(y, m, d).unwrap();
1931///
1932/// assert_eq!(from_ymd(2014, 1, 1) + TimeDelta::zero(), from_ymd(2014, 1, 1));
1933/// assert_eq!(from_ymd(2014, 1, 1) + TimeDelta::try_seconds(86399).unwrap(), from_ymd(2014, 1, 1));
1934/// assert_eq!(
1935///     from_ymd(2014, 1, 1) + TimeDelta::try_seconds(-86399).unwrap(),
1936///     from_ymd(2014, 1, 1)
1937/// );
1938/// assert_eq!(from_ymd(2014, 1, 1) + TimeDelta::try_days(1).unwrap(), from_ymd(2014, 1, 2));
1939/// assert_eq!(from_ymd(2014, 1, 1) + TimeDelta::try_days(-1).unwrap(), from_ymd(2013, 12, 31));
1940/// assert_eq!(from_ymd(2014, 1, 1) + TimeDelta::try_days(364).unwrap(), from_ymd(2014, 12, 31));
1941/// assert_eq!(
1942///     from_ymd(2014, 1, 1) + TimeDelta::try_days(365 * 4 + 1).unwrap(),
1943///     from_ymd(2018, 1, 1)
1944/// );
1945/// assert_eq!(
1946///     from_ymd(2014, 1, 1) + TimeDelta::try_days(365 * 400 + 97).unwrap(),
1947///     from_ymd(2414, 1, 1)
1948/// );
1949/// ```
1950///
1951/// [`NaiveDate::checked_add_signed`]: crate::NaiveDate::checked_add_signed
1952impl Add<TimeDelta> for NaiveDate {
1953    type Output = NaiveDate;
1954
1955    #[inline]
1956    fn add(self, rhs: TimeDelta) -> NaiveDate {
1957        self.checked_add_signed(rhs).expect("`NaiveDate + TimeDelta` overflowed")
1958    }
1959}
1960
1961/// Add-assign of `TimeDelta` to `NaiveDate`.
1962///
1963/// This discards the fractional days in `TimeDelta`, rounding to the closest integral number of days
1964/// towards `TimeDelta::zero()`.
1965///
1966/// # Panics
1967///
1968/// Panics if the resulting date would be out of range.
1969/// Consider using [`NaiveDate::checked_add_signed`] to get an `Option` instead.
1970impl AddAssign<TimeDelta> for NaiveDate {
1971    #[inline]
1972    fn add_assign(&mut self, rhs: TimeDelta) {
1973        *self = self.add(rhs);
1974    }
1975}
1976
1977/// Add `Months` to `NaiveDate`.
1978///
1979/// The result will be clamped to valid days in the resulting month, see `checked_add_months` for
1980/// details.
1981///
1982/// # Panics
1983///
1984/// Panics if the resulting date would be out of range.
1985/// Consider using `NaiveDate::checked_add_months` to get an `Option` instead.
1986///
1987/// # Example
1988///
1989/// ```
1990/// use chrono::{Months, NaiveDate};
1991///
1992/// let from_ymd = |y, m, d| NaiveDate::from_ymd_opt(y, m, d).unwrap();
1993///
1994/// assert_eq!(from_ymd(2014, 1, 1) + Months::new(1), from_ymd(2014, 2, 1));
1995/// assert_eq!(from_ymd(2014, 1, 1) + Months::new(11), from_ymd(2014, 12, 1));
1996/// assert_eq!(from_ymd(2014, 1, 1) + Months::new(12), from_ymd(2015, 1, 1));
1997/// assert_eq!(from_ymd(2014, 1, 1) + Months::new(13), from_ymd(2015, 2, 1));
1998/// assert_eq!(from_ymd(2014, 1, 31) + Months::new(1), from_ymd(2014, 2, 28));
1999/// assert_eq!(from_ymd(2020, 1, 31) + Months::new(1), from_ymd(2020, 2, 29));
2000/// ```
2001impl Add<Months> for NaiveDate {
2002    type Output = NaiveDate;
2003
2004    fn add(self, months: Months) -> Self::Output {
2005        self.checked_add_months(months).expect("`NaiveDate + Months` out of range")
2006    }
2007}
2008
2009/// Subtract `Months` from `NaiveDate`.
2010///
2011/// The result will be clamped to valid days in the resulting month, see `checked_sub_months` for
2012/// details.
2013///
2014/// # Panics
2015///
2016/// Panics if the resulting date would be out of range.
2017/// Consider using `NaiveDate::checked_sub_months` to get an `Option` instead.
2018///
2019/// # Example
2020///
2021/// ```
2022/// use chrono::{Months, NaiveDate};
2023///
2024/// let from_ymd = |y, m, d| NaiveDate::from_ymd_opt(y, m, d).unwrap();
2025///
2026/// assert_eq!(from_ymd(2014, 1, 1) - Months::new(11), from_ymd(2013, 2, 1));
2027/// assert_eq!(from_ymd(2014, 1, 1) - Months::new(12), from_ymd(2013, 1, 1));
2028/// assert_eq!(from_ymd(2014, 1, 1) - Months::new(13), from_ymd(2012, 12, 1));
2029/// ```
2030impl Sub<Months> for NaiveDate {
2031    type Output = NaiveDate;
2032
2033    fn sub(self, months: Months) -> Self::Output {
2034        self.checked_sub_months(months).expect("`NaiveDate - Months` out of range")
2035    }
2036}
2037
2038/// Add `Days` to `NaiveDate`.
2039///
2040/// # Panics
2041///
2042/// Panics if the resulting date would be out of range.
2043/// Consider using `NaiveDate::checked_add_days` to get an `Option` instead.
2044impl Add<Days> for NaiveDate {
2045    type Output = NaiveDate;
2046
2047    fn add(self, days: Days) -> Self::Output {
2048        self.checked_add_days(days).expect("`NaiveDate + Days` out of range")
2049    }
2050}
2051
2052/// Subtract `Days` from `NaiveDate`.
2053///
2054/// # Panics
2055///
2056/// Panics if the resulting date would be out of range.
2057/// Consider using `NaiveDate::checked_sub_days` to get an `Option` instead.
2058impl Sub<Days> for NaiveDate {
2059    type Output = NaiveDate;
2060
2061    fn sub(self, days: Days) -> Self::Output {
2062        self.checked_sub_days(days).expect("`NaiveDate - Days` out of range")
2063    }
2064}
2065
2066/// Subtract `TimeDelta` from `NaiveDate`.
2067///
2068/// This discards the fractional days in `TimeDelta`, rounding to the closest integral number of
2069/// days towards `TimeDelta::zero()`.
2070/// It is the same as the addition with a negated `TimeDelta`.
2071///
2072/// # Panics
2073///
2074/// Panics if the resulting date would be out of range.
2075/// Consider using [`NaiveDate::checked_sub_signed`] to get an `Option` instead.
2076///
2077/// # Example
2078///
2079/// ```
2080/// use chrono::{NaiveDate, TimeDelta};
2081///
2082/// let from_ymd = |y, m, d| NaiveDate::from_ymd_opt(y, m, d).unwrap();
2083///
2084/// assert_eq!(from_ymd(2014, 1, 1) - TimeDelta::zero(), from_ymd(2014, 1, 1));
2085/// assert_eq!(from_ymd(2014, 1, 1) - TimeDelta::try_seconds(86399).unwrap(), from_ymd(2014, 1, 1));
2086/// assert_eq!(
2087///     from_ymd(2014, 1, 1) - TimeDelta::try_seconds(-86399).unwrap(),
2088///     from_ymd(2014, 1, 1)
2089/// );
2090/// assert_eq!(from_ymd(2014, 1, 1) - TimeDelta::try_days(1).unwrap(), from_ymd(2013, 12, 31));
2091/// assert_eq!(from_ymd(2014, 1, 1) - TimeDelta::try_days(-1).unwrap(), from_ymd(2014, 1, 2));
2092/// assert_eq!(from_ymd(2014, 1, 1) - TimeDelta::try_days(364).unwrap(), from_ymd(2013, 1, 2));
2093/// assert_eq!(
2094///     from_ymd(2014, 1, 1) - TimeDelta::try_days(365 * 4 + 1).unwrap(),
2095///     from_ymd(2010, 1, 1)
2096/// );
2097/// assert_eq!(
2098///     from_ymd(2014, 1, 1) - TimeDelta::try_days(365 * 400 + 97).unwrap(),
2099///     from_ymd(1614, 1, 1)
2100/// );
2101/// ```
2102///
2103/// [`NaiveDate::checked_sub_signed`]: crate::NaiveDate::checked_sub_signed
2104impl Sub<TimeDelta> for NaiveDate {
2105    type Output = NaiveDate;
2106
2107    #[inline]
2108    fn sub(self, rhs: TimeDelta) -> NaiveDate {
2109        self.checked_sub_signed(rhs).expect("`NaiveDate - TimeDelta` overflowed")
2110    }
2111}
2112
2113/// Subtract-assign `TimeDelta` from `NaiveDate`.
2114///
2115/// This discards the fractional days in `TimeDelta`, rounding to the closest integral number of
2116/// days towards `TimeDelta::zero()`.
2117/// It is the same as the addition with a negated `TimeDelta`.
2118///
2119/// # Panics
2120///
2121/// Panics if the resulting date would be out of range.
2122/// Consider using [`NaiveDate::checked_sub_signed`] to get an `Option` instead.
2123impl SubAssign<TimeDelta> for NaiveDate {
2124    #[inline]
2125    fn sub_assign(&mut self, rhs: TimeDelta) {
2126        *self = self.sub(rhs);
2127    }
2128}
2129
2130/// Subtracts another `NaiveDate` from the current date.
2131/// Returns a `TimeDelta` of integral numbers.
2132///
2133/// This does not overflow or underflow at all,
2134/// as all possible output fits in the range of `TimeDelta`.
2135///
2136/// The implementation is a wrapper around
2137/// [`NaiveDate::signed_duration_since`](#method.signed_duration_since).
2138///
2139/// # Example
2140///
2141/// ```
2142/// use chrono::{NaiveDate, TimeDelta};
2143///
2144/// let from_ymd = |y, m, d| NaiveDate::from_ymd_opt(y, m, d).unwrap();
2145///
2146/// assert_eq!(from_ymd(2014, 1, 1) - from_ymd(2014, 1, 1), TimeDelta::zero());
2147/// assert_eq!(from_ymd(2014, 1, 1) - from_ymd(2013, 12, 31), TimeDelta::try_days(1).unwrap());
2148/// assert_eq!(from_ymd(2014, 1, 1) - from_ymd(2014, 1, 2), TimeDelta::try_days(-1).unwrap());
2149/// assert_eq!(from_ymd(2014, 1, 1) - from_ymd(2013, 9, 23), TimeDelta::try_days(100).unwrap());
2150/// assert_eq!(from_ymd(2014, 1, 1) - from_ymd(2013, 1, 1), TimeDelta::try_days(365).unwrap());
2151/// assert_eq!(
2152///     from_ymd(2014, 1, 1) - from_ymd(2010, 1, 1),
2153///     TimeDelta::try_days(365 * 4 + 1).unwrap()
2154/// );
2155/// assert_eq!(
2156///     from_ymd(2014, 1, 1) - from_ymd(1614, 1, 1),
2157///     TimeDelta::try_days(365 * 400 + 97).unwrap()
2158/// );
2159/// ```
2160impl Sub<NaiveDate> for NaiveDate {
2161    type Output = TimeDelta;
2162
2163    #[inline]
2164    fn sub(self, rhs: NaiveDate) -> TimeDelta {
2165        self.signed_duration_since(rhs)
2166    }
2167}
2168
2169impl From<NaiveDateTime> for NaiveDate {
2170    fn from(naive_datetime: NaiveDateTime) -> Self {
2171        naive_datetime.date()
2172    }
2173}
2174
2175/// Iterator over `NaiveDate` with a step size of one day.
2176#[derive(Debug, Copy, Clone, Hash, PartialEq, PartialOrd, Eq, Ord)]
2177pub struct NaiveDateDaysIterator {
2178    value: NaiveDate,
2179}
2180
2181impl Iterator for NaiveDateDaysIterator {
2182    type Item = NaiveDate;
2183
2184    fn next(&mut self) -> Option<Self::Item> {
2185        // We return the current value, and have no way to return `NaiveDate::MAX`.
2186        let current = self.value;
2187        // This can't panic because current is < NaiveDate::MAX:
2188        self.value = current.succ_opt()?;
2189        Some(current)
2190    }
2191
2192    fn size_hint(&self) -> (usize, Option<usize>) {
2193        let exact_size = NaiveDate::MAX.signed_duration_since(self.value).num_days();
2194        (exact_size as usize, Some(exact_size as usize))
2195    }
2196}
2197
2198impl ExactSizeIterator for NaiveDateDaysIterator {}
2199
2200impl DoubleEndedIterator for NaiveDateDaysIterator {
2201    fn next_back(&mut self) -> Option<Self::Item> {
2202        // We return the current value, and have no way to return `NaiveDate::MIN`.
2203        let current = self.value;
2204        self.value = current.pred_opt()?;
2205        Some(current)
2206    }
2207}
2208
2209impl FusedIterator for NaiveDateDaysIterator {}
2210
2211/// Iterator over `NaiveDate` with a step size of one week.
2212#[derive(Debug, Copy, Clone, Hash, PartialEq, PartialOrd, Eq, Ord)]
2213pub struct NaiveDateWeeksIterator {
2214    value: NaiveDate,
2215}
2216
2217impl Iterator for NaiveDateWeeksIterator {
2218    type Item = NaiveDate;
2219
2220    fn next(&mut self) -> Option<Self::Item> {
2221        let current = self.value;
2222        self.value = current.checked_add_days(Days::new(7))?;
2223        Some(current)
2224    }
2225
2226    fn size_hint(&self) -> (usize, Option<usize>) {
2227        let exact_size = NaiveDate::MAX.signed_duration_since(self.value).num_weeks();
2228        (exact_size as usize, Some(exact_size as usize))
2229    }
2230}
2231
2232impl ExactSizeIterator for NaiveDateWeeksIterator {}
2233
2234impl DoubleEndedIterator for NaiveDateWeeksIterator {
2235    fn next_back(&mut self) -> Option<Self::Item> {
2236        let current = self.value;
2237        self.value = current.checked_sub_days(Days::new(7))?;
2238        Some(current)
2239    }
2240}
2241
2242impl FusedIterator for NaiveDateWeeksIterator {}
2243
2244/// The `Debug` output of the naive date `d` is the same as
2245/// [`d.format("%Y-%m-%d")`](crate::format::strftime).
2246///
2247/// The string printed can be readily parsed via the `parse` method on `str`.
2248///
2249/// # Example
2250///
2251/// ```
2252/// use chrono::NaiveDate;
2253///
2254/// assert_eq!(format!("{:?}", NaiveDate::from_ymd_opt(2015, 9, 5).unwrap()), "2015-09-05");
2255/// assert_eq!(format!("{:?}", NaiveDate::from_ymd_opt(0, 1, 1).unwrap()), "0000-01-01");
2256/// assert_eq!(format!("{:?}", NaiveDate::from_ymd_opt(9999, 12, 31).unwrap()), "9999-12-31");
2257/// ```
2258///
2259/// ISO 8601 requires an explicit sign for years before 1 BCE or after 9999 CE.
2260///
2261/// ```
2262/// # use chrono::NaiveDate;
2263/// assert_eq!(format!("{:?}", NaiveDate::from_ymd_opt(-1, 1, 1).unwrap()), "-0001-01-01");
2264/// assert_eq!(format!("{:?}", NaiveDate::from_ymd_opt(10000, 12, 31).unwrap()), "+10000-12-31");
2265/// ```
2266impl fmt::Debug for NaiveDate {
2267    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2268        use core::fmt::Write;
2269
2270        let year = self.year();
2271        let mdf = self.mdf();
2272        if (0..=9999).contains(&year) {
2273            write_hundreds(f, (year / 100) as u8)?;
2274            write_hundreds(f, (year % 100) as u8)?;
2275        } else {
2276            // ISO 8601 requires the explicit sign for out-of-range years
2277            write!(f, "{year:+05}")?;
2278        }
2279
2280        f.write_char('-')?;
2281        write_hundreds(f, mdf.month() as u8)?;
2282        f.write_char('-')?;
2283        write_hundreds(f, mdf.day() as u8)
2284    }
2285}
2286
2287/// The `Display` output of the naive date `d` is the same as
2288/// [`d.format("%Y-%m-%d")`](crate::format::strftime).
2289///
2290/// The string printed can be readily parsed via the `parse` method on `str`.
2291///
2292/// # Example
2293///
2294/// ```
2295/// use chrono::NaiveDate;
2296///
2297/// assert_eq!(format!("{}", NaiveDate::from_ymd_opt(2015, 9, 5).unwrap()), "2015-09-05");
2298/// assert_eq!(format!("{}", NaiveDate::from_ymd_opt(0, 1, 1).unwrap()), "0000-01-01");
2299/// assert_eq!(format!("{}", NaiveDate::from_ymd_opt(9999, 12, 31).unwrap()), "9999-12-31");
2300/// ```
2301///
2302/// ISO 8601 requires an explicit sign for years before 1 BCE or after 9999 CE.
2303///
2304/// ```
2305/// # use chrono::NaiveDate;
2306/// assert_eq!(format!("{}", NaiveDate::from_ymd_opt(-1, 1, 1).unwrap()), "-0001-01-01");
2307/// assert_eq!(format!("{}", NaiveDate::from_ymd_opt(10000, 12, 31).unwrap()), "+10000-12-31");
2308/// ```
2309impl fmt::Display for NaiveDate {
2310    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2311        fmt::Debug::fmt(self, f)
2312    }
2313}
2314
2315/// Parsing a `str` into a `NaiveDate` uses the same format,
2316/// [`%Y-%m-%d`](crate::format::strftime), as in `Debug` and `Display`.
2317///
2318/// # Example
2319///
2320/// ```
2321/// use chrono::NaiveDate;
2322///
2323/// let d = NaiveDate::from_ymd_opt(2015, 9, 18).unwrap();
2324/// assert_eq!("2015-09-18".parse::<NaiveDate>(), Ok(d));
2325///
2326/// let d = NaiveDate::from_ymd_opt(12345, 6, 7).unwrap();
2327/// assert_eq!("+12345-6-7".parse::<NaiveDate>(), Ok(d));
2328///
2329/// assert!("foo".parse::<NaiveDate>().is_err());
2330/// ```
2331impl str::FromStr for NaiveDate {
2332    type Err = ParseError;
2333
2334    fn from_str(s: &str) -> ParseResult<NaiveDate> {
2335        const ITEMS: &[Item<'static>] = &[
2336            Item::Numeric(Numeric::Year, Pad::Zero),
2337            Item::Space(""),
2338            Item::Literal("-"),
2339            Item::Numeric(Numeric::Month, Pad::Zero),
2340            Item::Space(""),
2341            Item::Literal("-"),
2342            Item::Numeric(Numeric::Day, Pad::Zero),
2343            Item::Space(""),
2344        ];
2345
2346        let mut parsed = Parsed::new();
2347        parse(&mut parsed, s, ITEMS.iter())?;
2348        parsed.to_naive_date()
2349    }
2350}
2351
2352/// The default value for a NaiveDate is 1st of January 1970.
2353///
2354/// # Example
2355///
2356/// ```rust
2357/// use chrono::NaiveDate;
2358///
2359/// let default_date = NaiveDate::default();
2360/// assert_eq!(default_date, NaiveDate::from_ymd_opt(1970, 1, 1).unwrap());
2361/// ```
2362impl Default for NaiveDate {
2363    fn default() -> Self {
2364        NaiveDate::from_ymd_opt(1970, 1, 1).unwrap()
2365    }
2366}
2367
2368const fn cycle_to_yo(cycle: u32) -> (u32, u32) {
2369    let mut year_mod_400 = cycle / 365;
2370    let mut ordinal0 = cycle % 365;
2371    let delta = YEAR_DELTAS[year_mod_400 as usize] as u32;
2372    if ordinal0 < delta {
2373        year_mod_400 -= 1;
2374        ordinal0 += 365 - YEAR_DELTAS[year_mod_400 as usize] as u32;
2375    } else {
2376        ordinal0 -= delta;
2377    }
2378    (year_mod_400, ordinal0 + 1)
2379}
2380
2381const fn yo_to_cycle(year_mod_400: u32, ordinal: u32) -> u32 {
2382    year_mod_400 * 365 + YEAR_DELTAS[year_mod_400 as usize] as u32 + ordinal - 1
2383}
2384
2385const fn div_mod_floor(val: i32, div: i32) -> (i32, i32) {
2386    (val.div_euclid(div), val.rem_euclid(div))
2387}
2388
2389/// MAX_YEAR is one year less than the type is capable of representing. Internally we may sometimes
2390/// use the headroom, notably to handle cases where the offset of a `DateTime` constructed with
2391/// `NaiveDate::MAX` pushes it beyond the valid, representable range.
2392pub(super) const MAX_YEAR: i32 = (i32::MAX >> 13) - 1;
2393
2394/// MIN_YEAR is one year more than the type is capable of representing. Internally we may sometimes
2395/// use the headroom, notably to handle cases where the offset of a `DateTime` constructed with
2396/// `NaiveDate::MIN` pushes it beyond the valid, representable range.
2397pub(super) const MIN_YEAR: i32 = (i32::MIN >> 13) + 1;
2398
2399const ORDINAL_MASK: i32 = 0b1_1111_1111_0000;
2400
2401const LEAP_YEAR_MASK: i32 = 0b1000;
2402
2403// OL: ordinal and leap year flag.
2404// With only these parts of the date an ordinal 366 in a common year would be encoded as
2405// `((366 << 1) | 1) << 3`, and in a leap year as `((366 << 1) | 0) << 3`, which is less.
2406// This allows for efficiently checking the ordinal exists depending on whether this is a leap year.
2407const OL_MASK: i32 = ORDINAL_MASK | LEAP_YEAR_MASK;
2408const MAX_OL: i32 = 366 << 4;
2409
2410// Weekday of the last day in the preceding year.
2411// Allows for quick day of week calculation from the 1-based ordinal.
2412const WEEKDAY_FLAGS_MASK: i32 = 0b111;
2413
2414const YEAR_FLAGS_MASK: i32 = LEAP_YEAR_MASK | WEEKDAY_FLAGS_MASK;
2415
2416const YEAR_DELTAS: &[u8; 401] = &[
2417    0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5, 6, 6, 6, 6, 7, 7, 7, 7, 8, 8, 8,
2418    8, 9, 9, 9, 9, 10, 10, 10, 10, 11, 11, 11, 11, 12, 12, 12, 12, 13, 13, 13, 13, 14, 14, 14, 14,
2419    15, 15, 15, 15, 16, 16, 16, 16, 17, 17, 17, 17, 18, 18, 18, 18, 19, 19, 19, 19, 20, 20, 20, 20,
2420    21, 21, 21, 21, 22, 22, 22, 22, 23, 23, 23, 23, 24, 24, 24, 24, 25, 25, 25, // 100
2421    25, 25, 25, 25, 25, 26, 26, 26, 26, 27, 27, 27, 27, 28, 28, 28, 28, 29, 29, 29, 29, 30, 30, 30,
2422    30, 31, 31, 31, 31, 32, 32, 32, 32, 33, 33, 33, 33, 34, 34, 34, 34, 35, 35, 35, 35, 36, 36, 36,
2423    36, 37, 37, 37, 37, 38, 38, 38, 38, 39, 39, 39, 39, 40, 40, 40, 40, 41, 41, 41, 41, 42, 42, 42,
2424    42, 43, 43, 43, 43, 44, 44, 44, 44, 45, 45, 45, 45, 46, 46, 46, 46, 47, 47, 47, 47, 48, 48, 48,
2425    48, 49, 49, 49, // 200
2426    49, 49, 49, 49, 49, 50, 50, 50, 50, 51, 51, 51, 51, 52, 52, 52, 52, 53, 53, 53, 53, 54, 54, 54,
2427    54, 55, 55, 55, 55, 56, 56, 56, 56, 57, 57, 57, 57, 58, 58, 58, 58, 59, 59, 59, 59, 60, 60, 60,
2428    60, 61, 61, 61, 61, 62, 62, 62, 62, 63, 63, 63, 63, 64, 64, 64, 64, 65, 65, 65, 65, 66, 66, 66,
2429    66, 67, 67, 67, 67, 68, 68, 68, 68, 69, 69, 69, 69, 70, 70, 70, 70, 71, 71, 71, 71, 72, 72, 72,
2430    72, 73, 73, 73, // 300
2431    73, 73, 73, 73, 73, 74, 74, 74, 74, 75, 75, 75, 75, 76, 76, 76, 76, 77, 77, 77, 77, 78, 78, 78,
2432    78, 79, 79, 79, 79, 80, 80, 80, 80, 81, 81, 81, 81, 82, 82, 82, 82, 83, 83, 83, 83, 84, 84, 84,
2433    84, 85, 85, 85, 85, 86, 86, 86, 86, 87, 87, 87, 87, 88, 88, 88, 88, 89, 89, 89, 89, 90, 90, 90,
2434    90, 91, 91, 91, 91, 92, 92, 92, 92, 93, 93, 93, 93, 94, 94, 94, 94, 95, 95, 95, 95, 96, 96, 96,
2435    96, 97, 97, 97, 97, // 400+1
2436];
2437
2438#[cfg(feature = "serde")]
2439mod serde {
2440    use super::NaiveDate;
2441    use core::fmt;
2442    use serde::{de, ser};
2443
2444    // TODO not very optimized for space (binary formats would want something better)
2445
2446    impl ser::Serialize for NaiveDate {
2447        fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
2448        where
2449            S: ser::Serializer,
2450        {
2451            struct FormatWrapped<'a, D: 'a> {
2452                inner: &'a D,
2453            }
2454
2455            impl<D: fmt::Debug> fmt::Display for FormatWrapped<'_, D> {
2456                fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2457                    self.inner.fmt(f)
2458                }
2459            }
2460
2461            serializer.collect_str(&FormatWrapped { inner: &self })
2462        }
2463    }
2464
2465    struct NaiveDateVisitor;
2466
2467    impl de::Visitor<'_> for NaiveDateVisitor {
2468        type Value = NaiveDate;
2469
2470        fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
2471            formatter.write_str("a formatted date string")
2472        }
2473
2474        fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
2475        where
2476            E: de::Error,
2477        {
2478            value.parse().map_err(E::custom)
2479        }
2480    }
2481
2482    impl<'de> de::Deserialize<'de> for NaiveDate {
2483        fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
2484        where
2485            D: de::Deserializer<'de>,
2486        {
2487            deserializer.deserialize_str(NaiveDateVisitor)
2488        }
2489    }
2490
2491    #[cfg(test)]
2492    mod tests {
2493        use crate::NaiveDate;
2494
2495        #[test]
2496        fn test_serde_serialize() {
2497            assert_eq!(
2498                serde_json::to_string(&NaiveDate::from_ymd_opt(2014, 7, 24).unwrap()).ok(),
2499                Some(r#""2014-07-24""#.into())
2500            );
2501            assert_eq!(
2502                serde_json::to_string(&NaiveDate::from_ymd_opt(0, 1, 1).unwrap()).ok(),
2503                Some(r#""0000-01-01""#.into())
2504            );
2505            assert_eq!(
2506                serde_json::to_string(&NaiveDate::from_ymd_opt(-1, 12, 31).unwrap()).ok(),
2507                Some(r#""-0001-12-31""#.into())
2508            );
2509            assert_eq!(
2510                serde_json::to_string(&NaiveDate::MIN).ok(),
2511                Some(r#""-262143-01-01""#.into())
2512            );
2513            assert_eq!(
2514                serde_json::to_string(&NaiveDate::MAX).ok(),
2515                Some(r#""+262142-12-31""#.into())
2516            );
2517        }
2518
2519        #[test]
2520        fn test_serde_deserialize() {
2521            let from_str = serde_json::from_str::<NaiveDate>;
2522
2523            assert_eq!(
2524                from_str(r#""2016-07-08""#).ok(),
2525                Some(NaiveDate::from_ymd_opt(2016, 7, 8).unwrap())
2526            );
2527            assert_eq!(
2528                from_str(r#""2016-7-8""#).ok(),
2529                Some(NaiveDate::from_ymd_opt(2016, 7, 8).unwrap())
2530            );
2531            assert_eq!(from_str(r#""+002016-07-08""#).ok(), NaiveDate::from_ymd_opt(2016, 7, 8));
2532            assert_eq!(
2533                from_str(r#""0000-01-01""#).ok(),
2534                Some(NaiveDate::from_ymd_opt(0, 1, 1).unwrap())
2535            );
2536            assert_eq!(
2537                from_str(r#""0-1-1""#).ok(),
2538                Some(NaiveDate::from_ymd_opt(0, 1, 1).unwrap())
2539            );
2540            assert_eq!(
2541                from_str(r#""-0001-12-31""#).ok(),
2542                Some(NaiveDate::from_ymd_opt(-1, 12, 31).unwrap())
2543            );
2544            assert_eq!(from_str(r#""-262143-01-01""#).ok(), Some(NaiveDate::MIN));
2545            assert_eq!(from_str(r#""+262142-12-31""#).ok(), Some(NaiveDate::MAX));
2546
2547            // bad formats
2548            assert!(from_str(r#""""#).is_err());
2549            assert!(from_str(r#""20001231""#).is_err());
2550            assert!(from_str(r#""2000-00-00""#).is_err());
2551            assert!(from_str(r#""2000-02-30""#).is_err());
2552            assert!(from_str(r#""2001-02-29""#).is_err());
2553            assert!(from_str(r#""2002-002-28""#).is_err());
2554            assert!(from_str(r#""yyyy-mm-dd""#).is_err());
2555            assert!(from_str(r#"0"#).is_err());
2556            assert!(from_str(r#"20.01"#).is_err());
2557            let min = i32::MIN.to_string();
2558            assert!(from_str(&min).is_err());
2559            let max = i32::MAX.to_string();
2560            assert!(from_str(&max).is_err());
2561            let min = i64::MIN.to_string();
2562            assert!(from_str(&min).is_err());
2563            let max = i64::MAX.to_string();
2564            assert!(from_str(&max).is_err());
2565            assert!(from_str(r#"{}"#).is_err());
2566        }
2567
2568        #[test]
2569        fn test_serde_bincode() {
2570            // Bincode is relevant to test separately from JSON because
2571            // it is not self-describing.
2572            use bincode::{deserialize, serialize};
2573
2574            let d = NaiveDate::from_ymd_opt(2014, 7, 24).unwrap();
2575            let encoded = serialize(&d).unwrap();
2576            let decoded: NaiveDate = deserialize(&encoded).unwrap();
2577            assert_eq!(d, decoded);
2578        }
2579    }
2580}