1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

#![cfg_attr(not(feature = "std"), no_std)]
#![allow(clippy::new_without_default)]

//! An implementation of the proleptic Gregorian calendar, compatible with ISO 8601.
//! Amongst others, that means that the calendar has a year zero preceeding the year 1.
//!
//! This create does not deal with times or time zones.
//!
//! The [`Date`] type represents a date (year, month and day),
//! the [`Year`] type represents a calendar year,
//! the [`Month`] type represents a calendar month,
//! and the [`YearMonth`] type represents a month of a specific year.
//!
//! Where possible, things are implemented as `const fn`.
//! Currently, this excludes trait implementations and functions that rely on traits.
//!
//! # Example
//! ```
//! use gregorian::{Date, Month::*, Year, YearMonth};
//!
//! assert!(Year::new(2020).has_leap_day(), true);
//! assert!(YearMonth::new(1900, February).total_days() == 28);
//! assert!(YearMonth::new(2000, February).total_days() == 29);
//!
//! assert!(Year::new(2020).with_month(March).first_day() == Date::new(2020, March, 1).unwrap());
//! assert!(Year::new(2020).with_month(March).last_day() == Date::new(2020, March, 31).unwrap());
//!
//! assert!(Year::new(2020).first_day() == Date::new(2020, 1, 1).unwrap());
//! assert!(Year::new(2020).last_day() == Date::new(2020, 12, 31).unwrap());
//!
//! assert!(Date::new(2020, 2, 1).unwrap().day_of_year() == 32);
//! ```
//!
//! # Rounding invalid dates
//! When you use [`Date::add_years()`] or [`Date::add_months()`], you can get invalid dates.
//! These are reported with an [`InvalidDayOfMonth`] error which has the
//! [`next_valid()`][InvalidDayOfMonth::next_valid] and [`prev_valid()`][InvalidDayOfMonth::prev_valid] methods.
//! Those can be used to get the next or previous valid date instead.
//!
//! Additionally, there is an extension trait for `Result<Date, InvalidDayOfMonth>` with the
//! [`or_next_valid()`][DateResultExt::or_next_valid] and [`or_prev_valid()`][DateResultExt::or_prev_valid] methods.
//! This allows you to directly round the date on the `Result` object.
//!
//!```
//! use gregorian::{Date, DateResultExt};
//! let date = Date::new(2020, 1, 31).unwrap();
//! assert!(date.add_months(1).or_next_valid() == Date::new(2020, 3, 1).unwrap());
//! assert!(date.add_months(1).or_prev_valid() == Date::new(2020, 2, 29).unwrap());
//! ```

mod date;
mod error;
mod ext;
mod month;
mod raw;
mod util;
mod year;
mod year_month;

pub use date::*;
pub use error::*;
pub use ext::*;
pub use month::*;
pub use year::*;
pub use year_month::*;