better documentation, some additional APIs.
- `Date/Time - Duration` is now supported. (duh!) - `with_offset` methods have been added. - `LocalResult` now implements common traits. - `LocalResult` has several methods to propagate errors. this makes the initialization from untrusted sources easier (`off.ymd_opt(y,m,d).and_hms_opt(h,n,s).single()`).
This commit is contained in:
parent
9e6576e37e
commit
920a681d54
181
README.md
181
README.md
|
@ -1,55 +1,162 @@
|
||||||
Rust-chrono
|
Chrono
|
||||||
===========
|
======
|
||||||
|
|
||||||
[![Rust-chrono on Travis CI][travis-image]][travis]
|
[![Chrono on Travis CI][travis-image]][travis]
|
||||||
|
|
||||||
[travis-image]: https://travis-ci.org/lifthrasiir/rust-chrono.png
|
[travis-image]: https://travis-ci.org/lifthrasiir/rust-chrono.png
|
||||||
[travis]: https://travis-ci.org/lifthrasiir/rust-chrono
|
[travis]: https://travis-ci.org/lifthrasiir/rust-chrono
|
||||||
|
|
||||||
Date and time handling for Rust.
|
Date and time handling for Rust.
|
||||||
|
It aims to be a feature-complete superset of the [time](https://github.com/rust-lang/time) library.
|
||||||
|
In particular,
|
||||||
|
|
||||||
|
* Chrono strictly adheres to ISO 8601.
|
||||||
|
* Chrono is timezone-aware by default, with separate timezone-naive types.
|
||||||
|
* Chrono is space-optimal and (while not being the primary goal) reasonably efficient.
|
||||||
|
|
||||||
|
There were several previous attempts to bring a good date and time library to Rust,
|
||||||
|
which Chrono builts upon and should acknowledge:
|
||||||
|
|
||||||
|
* [Initial research on the wiki](https://github.com/rust-lang/rust/wiki/Lib-datetime)
|
||||||
|
* Dietrich Epp's [datetime-rs](https://github.com/depp/datetime-rs)
|
||||||
|
* Luis de Bethencourt's [rust-datetime](https://github.com/luisbg/rust-datetime)
|
||||||
|
|
||||||
[Complete Documentation](https://lifthrasiir.github.io/rust-chrono/chrono/)
|
[Complete Documentation](https://lifthrasiir.github.io/rust-chrono/chrono/)
|
||||||
|
|
||||||
```rust
|
## Duration
|
||||||
// find out if the doomsday rule is correct!
|
|
||||||
use chrono::{Weekday, NaiveDate, naive};
|
|
||||||
use std::iter::range_inclusive;
|
|
||||||
|
|
||||||
for y in range_inclusive(naive::date::MIN.year(), naive::date::MAX.year()) {
|
Chrono used to have a `Duration` type, which represents the time span.
|
||||||
// even months
|
Now Rust standard library includes it as `std::time::duration::Duration` and
|
||||||
let d4 = NaiveDate::from_ymd(y, 4, 4);
|
Chrono simply reexports it.
|
||||||
let d6 = NaiveDate::from_ymd(y, 6, 6);
|
|
||||||
let d8 = NaiveDate::from_ymd(y, 8, 8);
|
|
||||||
let d10 = NaiveDate::from_ymd(y, 10, 10);
|
|
||||||
let d12 = NaiveDate::from_ymd(y, 12, 12);
|
|
||||||
|
|
||||||
// nine to five, seven-eleven
|
## Date and Time
|
||||||
let d59 = NaiveDate::from_ymd(y, 5, 9);
|
|
||||||
let d95 = NaiveDate::from_ymd(y, 9, 5);
|
|
||||||
let d711 = NaiveDate::from_ymd(y, 7, 11);
|
|
||||||
let d117 = NaiveDate::from_ymd(y, 11, 7);
|
|
||||||
|
|
||||||
// "March 0"
|
Chrono provides a `DateTime` type for the combined date and time.
|
||||||
let d30 = NaiveDate::from_ymd(y, 3, 1).pred();
|
|
||||||
|
|
||||||
let weekday = d30.weekday();
|
`DateTime`, among others, is timezone-aware and
|
||||||
let other_dates = [d4, d6, d8, d10, d12, d59, d95, d711, d117];
|
must be constructed from the timezone object (`Offset`).
|
||||||
assert!(other_dates.iter().all(|d| d.weekday() == weekday));
|
`DateTime`s with different offsets do not mix, but can be converted to each other.
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Design Goals
|
You can get the current date and time in the UTC timezone (`UTC::now()`)
|
||||||
------------
|
or in the local timezone (`Local::now()`).
|
||||||
|
|
||||||
* 1-to-1 correspondence with ISO 8601.
|
~~~~ {.rust}
|
||||||
* Timezone-aware by default.
|
use chrono::{UTC, Local, DateTime};
|
||||||
* Space efficient.
|
|
||||||
* Moderate lookup table size, should not exceed a few KBs.
|
|
||||||
* Avoid divisions as much as possible.
|
|
||||||
|
|
||||||
References
|
let utc: DateTime<UTC> = UTC::now(); // e.g. `2014-11-28T12:45:59.324310806Z`
|
||||||
----------
|
let local: DateTime<Local> = Local::now(); // e.g. `2014-11-28T21:45:59.324310806+09:00`
|
||||||
|
# let _ = utc; let _ = local;
|
||||||
|
~~~~
|
||||||
|
|
||||||
* https://github.com/mozilla/rust/wiki/Lib-datetime
|
Alternatively, you can create your own date and time.
|
||||||
* https://github.com/luisbg/rust-datetime/wiki/Use-Cases
|
This is a bit verbose due to Rust's lack of function and method overloading,
|
||||||
|
but in turn we get a rich combination of initialization methods.
|
||||||
|
|
||||||
|
~~~~ {.rust}
|
||||||
|
use chrono::{UTC, Offset, Weekday, LocalResult};
|
||||||
|
|
||||||
|
let dt = UTC.ymd(2014, 7, 8).and_hms(9, 10, 11); // `2014-07-08T09:10:11Z`
|
||||||
|
// July 8 is 188th day of the year 2014 (`o` for "ordinal")
|
||||||
|
assert_eq!(dt, UTC.yo(2014, 189).and_hms(9, 10, 11));
|
||||||
|
// July 8 is Tuesday in ISO week 28 of the year 2014.
|
||||||
|
assert_eq!(dt, UTC.isoywd(2014, 28, Weekday::Tue).and_hms(9, 10, 11));
|
||||||
|
|
||||||
|
let dt = UTC.ymd(2014, 7, 8).and_hms_milli(9, 10, 11, 12); // `2014-07-08T09:10:11.012Z`
|
||||||
|
assert_eq!(dt, UTC.ymd(2014, 7, 8).and_hms_micro(9, 10, 11, 12_000));
|
||||||
|
assert_eq!(dt, UTC.ymd(2014, 7, 8).and_hms_nano(9, 10, 11, 12_000_000));
|
||||||
|
|
||||||
|
// dynamic verification
|
||||||
|
assert_eq!(UTC.ymd_opt(2014, 7, 8).and_hms_opt(21, 15, 33),
|
||||||
|
LocalResult::Single(UTC.ymd(2014, 7, 8).and_hms(21, 15, 33)));
|
||||||
|
assert_eq!(UTC.ymd_opt(2014, 7, 8).and_hms_opt(80, 15, 33), LocalResult::None);
|
||||||
|
assert_eq!(UTC.ymd_opt(2014, 7, 38).and_hms_opt(21, 15, 33), LocalResult::None);
|
||||||
|
~~~~
|
||||||
|
|
||||||
|
Various properties are available to the date and time, and can be altered individually.
|
||||||
|
Most of them are defined in the traits `Datelike` and `Timelike` which you should `use` before.
|
||||||
|
Addition and subtraction is also supported.
|
||||||
|
The following illustrates most supported operations to the date and time:
|
||||||
|
|
||||||
|
~~~~ {.rust}
|
||||||
|
# /* we intentionally fake the datetime...
|
||||||
|
use chrono::{UTC, Local, Datelike, Timelike, Weekday, Duration};
|
||||||
|
|
||||||
|
// assume this returned `2014-11-28T21:45:59.324310806+09:00`:
|
||||||
|
let dt = Local::now();
|
||||||
|
# */ // up to here. we now define a fixed datetime for the illustrative purpose.
|
||||||
|
# use chrono::{UTC, FixedOffset, Offset, Datelike, Timelike, Weekday, Duration};
|
||||||
|
# let dt = FixedOffset::east(9*3600).ymd(2014, 11, 28).and_hms_nano(21, 45, 59, 324310806);
|
||||||
|
|
||||||
|
// property accessors
|
||||||
|
assert_eq!((dt.year(), dt.month(), dt.day()), (2014, 11, 28));
|
||||||
|
assert_eq!((dt.month0(), dt.day0()), (10, 27)); // for unfortunate souls
|
||||||
|
assert_eq!((dt.hour(), dt.minute(), dt.second()), (21, 45, 59));
|
||||||
|
assert_eq!(dt.weekday(), Weekday::Fri);
|
||||||
|
assert_eq!(dt.weekday().number_from_monday(), 5); // Mon=1, ..., Sat=7
|
||||||
|
assert_eq!(dt.ordinal(), 332); // the day of year
|
||||||
|
assert_eq!(dt.num_days_from_ce(), 735565); // the number of days from and including Jan 1, 1
|
||||||
|
|
||||||
|
// offset accessor and manipulation
|
||||||
|
assert_eq!(dt.offset().local_minus_utc(), Duration::hours(9));
|
||||||
|
assert_eq!(dt.with_offset(UTC), UTC.ymd(2014, 11, 28).and_hms_nano(12, 45, 59, 324310806));
|
||||||
|
|
||||||
|
// a sample of property manipulations (validates dynamically)
|
||||||
|
assert_eq!(dt.with_day(29).unwrap().weekday(), Weekday::Sat); // 2014-11-29 is Saturday
|
||||||
|
assert_eq!(dt.with_day(32), None);
|
||||||
|
assert_eq!(dt.with_year(-300).unwrap().num_days_from_ce(), -109606); // November 29, 301 BCE
|
||||||
|
|
||||||
|
// arithmetic operations
|
||||||
|
assert_eq!(UTC.ymd(2014, 11, 14).and_hms(8, 9, 10) - UTC.ymd(2014, 11, 14).and_hms(10, 9, 8),
|
||||||
|
Duration::seconds(-2 * 3600 + 2));
|
||||||
|
assert_eq!(UTC.ymd(1970, 1, 1).and_hms(0, 0, 0) + Duration::seconds(1_000_000_000),
|
||||||
|
UTC.ymd(2001, 9, 9).and_hms(1, 46, 40));
|
||||||
|
assert_eq!(UTC.ymd(1970, 1, 1).and_hms(0, 0, 0) - Duration::seconds(1_000_000_000),
|
||||||
|
UTC.ymd(1938, 4, 24).and_hms(22, 13, 20));
|
||||||
|
~~~~
|
||||||
|
|
||||||
|
Formatting is done via the `format` method,
|
||||||
|
which format is equivalent to the familiar `strftime` format.
|
||||||
|
The default `to_string` method also gives a reasonable representation.
|
||||||
|
|
||||||
|
~~~~ {.rust}
|
||||||
|
use chrono::{UTC, Offset};
|
||||||
|
|
||||||
|
let dt = UTC.ymd(2014, 11, 28).and_hms(12, 0, 9);
|
||||||
|
assert_eq!(dt.format("%Y-%m-%d %H:%M:%S").to_string(), "2014-11-28 12:00:09".into_string());
|
||||||
|
assert_eq!(dt.format("%a %b %e %T %Y").to_string(), "Fri Nov 28 12:00:09 2014".into_string());
|
||||||
|
assert_eq!(dt.format("%a %b %e %T %Y").to_string(), dt.format("%c").to_string());
|
||||||
|
|
||||||
|
assert_eq!(dt.to_string(), "2014-11-28T12:00:09Z".into_string());
|
||||||
|
~~~~
|
||||||
|
|
||||||
|
## Individual date and time
|
||||||
|
|
||||||
|
Chrono also provides an individual date type (`Date`) and time type (`Time`).
|
||||||
|
They also have offsets attached, and have to be constructed via offsets.
|
||||||
|
Most operations available to `DateTime` are also available to `Date` and `Time`
|
||||||
|
whenever appropriate.
|
||||||
|
|
||||||
|
~~~~ {.rust}
|
||||||
|
use chrono::{UTC, Local, Offset, LocalResult, Datelike, Weekday};
|
||||||
|
|
||||||
|
# // these *may* fail, but only very rarely. just rerun the test if you were that unfortunate ;)
|
||||||
|
assert_eq!(UTC::today(), UTC::now().date());
|
||||||
|
assert_eq!(Local::today(), Local::now().date());
|
||||||
|
|
||||||
|
assert_eq!(UTC.ymd(2014, 11, 28).weekday(), Weekday::Fri);
|
||||||
|
assert_eq!(UTC.ymd_opt(2014, 11, 31), LocalResult::None);
|
||||||
|
assert_eq!(UTC.hms_milli(7, 8, 9, 10).format("%H%M%S").to_string(), "070809".into_string());
|
||||||
|
~~~~
|
||||||
|
|
||||||
|
`DateTime` has two methods, `date` and `time`,
|
||||||
|
which return narrow views to its date and time components respectively.
|
||||||
|
|
||||||
|
## Naive date and time
|
||||||
|
|
||||||
|
Chrono provides naive counterparts to `Date`, `Time` and `DateTime`
|
||||||
|
as `NaiveDate`, `NaiveTime` and `NaiveDateTime` respectively.
|
||||||
|
|
||||||
|
They have almost equivalent interfaces as their timezone-aware twins,
|
||||||
|
but are not associated to offsets obviously and can be quite low-level.
|
||||||
|
They are mostly useful for building blocks for higher-level types.
|
||||||
|
|
||||||
|
|
30
src/date.rs
30
src/date.rs
|
@ -37,7 +37,7 @@ impl<Off:Offset> Date<Off> {
|
||||||
Date { date: date, offset: offset }
|
Date { date: date, offset: offset }
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Makes a new `NaiveDateTime` from the current date and given `NaiveTime`.
|
/// Makes a new `DateTime` from the current date and given `NaiveTime`.
|
||||||
/// The offset in the current date is preserved.
|
/// The offset in the current date is preserved.
|
||||||
///
|
///
|
||||||
/// Fails on invalid datetime.
|
/// Fails on invalid datetime.
|
||||||
|
@ -46,7 +46,7 @@ impl<Off:Offset> Date<Off> {
|
||||||
self.offset.from_local_datetime(&self.date.and_time(time)).single()
|
self.offset.from_local_datetime(&self.date.and_time(time)).single()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Makes a new `NaiveDateTime` from the current date, hour, minute and second.
|
/// Makes a new `DateTime` from the current date, hour, minute and second.
|
||||||
/// The offset in the current date is preserved.
|
/// The offset in the current date is preserved.
|
||||||
///
|
///
|
||||||
/// Fails on invalid hour, minute and/or second.
|
/// Fails on invalid hour, minute and/or second.
|
||||||
|
@ -55,7 +55,7 @@ impl<Off:Offset> Date<Off> {
|
||||||
self.and_hms_opt(hour, min, sec).expect("invalid time")
|
self.and_hms_opt(hour, min, sec).expect("invalid time")
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Makes a new `NaiveDateTime` from the current date, hour, minute and second.
|
/// Makes a new `DateTime` from the current date, hour, minute and second.
|
||||||
/// The offset in the current date is preserved.
|
/// The offset in the current date is preserved.
|
||||||
///
|
///
|
||||||
/// Returns `None` on invalid hour, minute and/or second.
|
/// Returns `None` on invalid hour, minute and/or second.
|
||||||
|
@ -64,7 +64,7 @@ impl<Off:Offset> Date<Off> {
|
||||||
NaiveTime::from_hms_opt(hour, min, sec).and_then(|time| self.and_time(time))
|
NaiveTime::from_hms_opt(hour, min, sec).and_then(|time| self.and_time(time))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Makes a new `NaiveDateTime` from the current date, hour, minute, second and millisecond.
|
/// Makes a new `DateTime` from the current date, hour, minute, second and millisecond.
|
||||||
/// The millisecond part can exceed 1,000 in order to represent the leap second.
|
/// The millisecond part can exceed 1,000 in order to represent the leap second.
|
||||||
/// The offset in the current date is preserved.
|
/// The offset in the current date is preserved.
|
||||||
///
|
///
|
||||||
|
@ -74,7 +74,7 @@ impl<Off:Offset> Date<Off> {
|
||||||
self.and_hms_milli_opt(hour, min, sec, milli).expect("invalid time")
|
self.and_hms_milli_opt(hour, min, sec, milli).expect("invalid time")
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Makes a new `NaiveDateTime` from the current date, hour, minute, second and millisecond.
|
/// Makes a new `DateTime` from the current date, hour, minute, second and millisecond.
|
||||||
/// The millisecond part can exceed 1,000 in order to represent the leap second.
|
/// The millisecond part can exceed 1,000 in order to represent the leap second.
|
||||||
/// The offset in the current date is preserved.
|
/// The offset in the current date is preserved.
|
||||||
///
|
///
|
||||||
|
@ -85,7 +85,7 @@ impl<Off:Offset> Date<Off> {
|
||||||
NaiveTime::from_hms_milli_opt(hour, min, sec, milli).and_then(|time| self.and_time(time))
|
NaiveTime::from_hms_milli_opt(hour, min, sec, milli).and_then(|time| self.and_time(time))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Makes a new `NaiveDateTime` from the current date, hour, minute, second and microsecond.
|
/// Makes a new `DateTime` from the current date, hour, minute, second and microsecond.
|
||||||
/// The microsecond part can exceed 1,000,000 in order to represent the leap second.
|
/// The microsecond part can exceed 1,000,000 in order to represent the leap second.
|
||||||
/// The offset in the current date is preserved.
|
/// The offset in the current date is preserved.
|
||||||
///
|
///
|
||||||
|
@ -95,7 +95,7 @@ impl<Off:Offset> Date<Off> {
|
||||||
self.and_hms_micro_opt(hour, min, sec, micro).expect("invalid time")
|
self.and_hms_micro_opt(hour, min, sec, micro).expect("invalid time")
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Makes a new `NaiveDateTime` from the current date, hour, minute, second and microsecond.
|
/// Makes a new `DateTime` from the current date, hour, minute, second and microsecond.
|
||||||
/// The microsecond part can exceed 1,000,000 in order to represent the leap second.
|
/// The microsecond part can exceed 1,000,000 in order to represent the leap second.
|
||||||
/// The offset in the current date is preserved.
|
/// The offset in the current date is preserved.
|
||||||
///
|
///
|
||||||
|
@ -106,7 +106,7 @@ impl<Off:Offset> Date<Off> {
|
||||||
NaiveTime::from_hms_micro_opt(hour, min, sec, micro).and_then(|time| self.and_time(time))
|
NaiveTime::from_hms_micro_opt(hour, min, sec, micro).and_then(|time| self.and_time(time))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Makes a new `NaiveDateTime` from the current date, hour, minute, second and nanosecond.
|
/// Makes a new `DateTime` from the current date, hour, minute, second and nanosecond.
|
||||||
/// The nanosecond part can exceed 1,000,000,000 in order to represent the leap second.
|
/// The nanosecond part can exceed 1,000,000,000 in order to represent the leap second.
|
||||||
/// The offset in the current date is preserved.
|
/// The offset in the current date is preserved.
|
||||||
///
|
///
|
||||||
|
@ -116,7 +116,7 @@ impl<Off:Offset> Date<Off> {
|
||||||
self.and_hms_nano_opt(hour, min, sec, nano).expect("invalid time")
|
self.and_hms_nano_opt(hour, min, sec, nano).expect("invalid time")
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Makes a new `NaiveDateTime` from the current date, hour, minute, second and nanosecond.
|
/// Makes a new `DateTime` from the current date, hour, minute, second and nanosecond.
|
||||||
/// The nanosecond part can exceed 1,000,000,000 in order to represent the leap second.
|
/// The nanosecond part can exceed 1,000,000,000 in order to represent the leap second.
|
||||||
/// The offset in the current date is preserved.
|
/// The offset in the current date is preserved.
|
||||||
///
|
///
|
||||||
|
@ -165,6 +165,13 @@ impl<Off:Offset> Date<Off> {
|
||||||
&self.offset
|
&self.offset
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Changes the associated offset.
|
||||||
|
/// This does not change the actual `Date` (but will change the string representation).
|
||||||
|
#[inline]
|
||||||
|
pub fn with_offset<Off2:Offset>(&self, offset: Off2) -> Date<Off2> {
|
||||||
|
Date::from_utc(self.date, offset)
|
||||||
|
}
|
||||||
|
|
||||||
/// Formats the date in the specified format string.
|
/// Formats the date in the specified format string.
|
||||||
/// See the `format` module on the supported escape sequences.
|
/// See the `format` module on the supported escape sequences.
|
||||||
#[inline]
|
#[inline]
|
||||||
|
@ -274,6 +281,11 @@ impl<Off:Offset, Off2:Offset> Sub<Date<Off2>,Duration> for Date<Off> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl<Off:Offset> Sub<Duration,Date<Off>> for Date<Off> {
|
||||||
|
#[inline]
|
||||||
|
fn sub(&self, rhs: &Duration) -> Date<Off> { self.add(&-*rhs) }
|
||||||
|
}
|
||||||
|
|
||||||
impl<Off:Offset> fmt::Show for Date<Off> {
|
impl<Off:Offset> fmt::Show for Date<Off> {
|
||||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||||
write!(f, "{}{}", self.local(), self.offset)
|
write!(f, "{}{}", self.local(), self.offset)
|
||||||
|
|
|
@ -55,6 +55,13 @@ impl<Off:Offset> DateTime<Off> {
|
||||||
&self.offset
|
&self.offset
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Changes the associated offset.
|
||||||
|
/// This does not change the actual `DateTime` (but will change the string representation).
|
||||||
|
#[inline]
|
||||||
|
pub fn with_offset<Off2:Offset>(&self, offset: Off2) -> DateTime<Off2> {
|
||||||
|
DateTime::from_utc(self.datetime, offset)
|
||||||
|
}
|
||||||
|
|
||||||
/// Formats the combined date and time in the specified format string.
|
/// Formats the combined date and time in the specified format string.
|
||||||
/// See the `format` module on the supported escape sequences.
|
/// See the `format` module on the supported escape sequences.
|
||||||
#[inline]
|
#[inline]
|
||||||
|
@ -196,6 +203,11 @@ impl<Off:Offset, Off2:Offset> Sub<DateTime<Off2>,Duration> for DateTime<Off> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl<Off:Offset> Sub<Duration,DateTime<Off>> for DateTime<Off> {
|
||||||
|
#[inline]
|
||||||
|
fn sub(&self, rhs: &Duration) -> DateTime<Off> { self.add(&-*rhs) }
|
||||||
|
}
|
||||||
|
|
||||||
impl<Off:Offset> fmt::Show for DateTime<Off> {
|
impl<Off:Offset> fmt::Show for DateTime<Off> {
|
||||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||||
write!(f, "{}{}", self.local(), self.offset)
|
write!(f, "{}{}", self.local(), self.offset)
|
||||||
|
|
158
src/lib.rs
158
src/lib.rs
|
@ -3,14 +3,168 @@
|
||||||
// See README.md and LICENSE.txt for details.
|
// See README.md and LICENSE.txt for details.
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
Experimental date and time handling for Rust.
|
|
||||||
|
# Chrono
|
||||||
|
|
||||||
|
Date and time handling for Rust.
|
||||||
|
It aims to be a feature-complete superset of the [time](https://github.com/rust-lang/time) library.
|
||||||
|
In particular,
|
||||||
|
|
||||||
|
* Chrono strictly adheres to ISO 8601.
|
||||||
|
* Chrono is timezone-aware by default, with separate timezone-naive types.
|
||||||
|
* Chrono is space-optimal and (while not being the primary goal) reasonably efficient.
|
||||||
|
|
||||||
|
There were several previous attempts to bring a good date and time library to Rust,
|
||||||
|
which Chrono builts upon and should acknowledge:
|
||||||
|
|
||||||
|
* [Initial research on the wiki](https://github.com/rust-lang/rust/wiki/Lib-datetime)
|
||||||
|
* Dietrich Epp's [datetime-rs](https://github.com/depp/datetime-rs)
|
||||||
|
* Luis de Bethencourt's [rust-datetime](https://github.com/luisbg/rust-datetime)
|
||||||
|
|
||||||
|
## Duration
|
||||||
|
|
||||||
|
Chrono used to have a `Duration` type, which represents the time span.
|
||||||
|
Now Rust standard library includes it as `std::time::duration::Duration` and
|
||||||
|
Chrono simply reexports it.
|
||||||
|
|
||||||
|
## Date and Time
|
||||||
|
|
||||||
|
Chrono provides a `DateTime` type for the combined date and time.
|
||||||
|
|
||||||
|
`DateTime`, among others, is timezone-aware and
|
||||||
|
must be constructed from the timezone object (`Offset`).
|
||||||
|
`DateTime`s with different offsets do not mix, but can be converted to each other.
|
||||||
|
|
||||||
|
You can get the current date and time in the UTC timezone (`UTC::now()`)
|
||||||
|
or in the local timezone (`Local::now()`).
|
||||||
|
|
||||||
|
~~~~ {.rust}
|
||||||
|
use chrono::{UTC, Local, DateTime};
|
||||||
|
|
||||||
|
let utc: DateTime<UTC> = UTC::now(); // e.g. `2014-11-28T12:45:59.324310806Z`
|
||||||
|
let local: DateTime<Local> = Local::now(); // e.g. `2014-11-28T21:45:59.324310806+09:00`
|
||||||
|
# let _ = utc; let _ = local;
|
||||||
|
~~~~
|
||||||
|
|
||||||
|
Alternatively, you can create your own date and time.
|
||||||
|
This is a bit verbose due to Rust's lack of function and method overloading,
|
||||||
|
but in turn we get a rich combination of initialization methods.
|
||||||
|
|
||||||
|
~~~~ {.rust}
|
||||||
|
use chrono::{UTC, Offset, Weekday, LocalResult};
|
||||||
|
|
||||||
|
let dt = UTC.ymd(2014, 7, 8).and_hms(9, 10, 11); // `2014-07-08T09:10:11Z`
|
||||||
|
// July 8 is 188th day of the year 2014 (`o` for "ordinal")
|
||||||
|
assert_eq!(dt, UTC.yo(2014, 189).and_hms(9, 10, 11));
|
||||||
|
// July 8 is Tuesday in ISO week 28 of the year 2014.
|
||||||
|
assert_eq!(dt, UTC.isoywd(2014, 28, Weekday::Tue).and_hms(9, 10, 11));
|
||||||
|
|
||||||
|
let dt = UTC.ymd(2014, 7, 8).and_hms_milli(9, 10, 11, 12); // `2014-07-08T09:10:11.012Z`
|
||||||
|
assert_eq!(dt, UTC.ymd(2014, 7, 8).and_hms_micro(9, 10, 11, 12_000));
|
||||||
|
assert_eq!(dt, UTC.ymd(2014, 7, 8).and_hms_nano(9, 10, 11, 12_000_000));
|
||||||
|
|
||||||
|
// dynamic verification
|
||||||
|
assert_eq!(UTC.ymd_opt(2014, 7, 8).and_hms_opt(21, 15, 33),
|
||||||
|
LocalResult::Single(UTC.ymd(2014, 7, 8).and_hms(21, 15, 33)));
|
||||||
|
assert_eq!(UTC.ymd_opt(2014, 7, 8).and_hms_opt(80, 15, 33), LocalResult::None);
|
||||||
|
assert_eq!(UTC.ymd_opt(2014, 7, 38).and_hms_opt(21, 15, 33), LocalResult::None);
|
||||||
|
~~~~
|
||||||
|
|
||||||
|
Various properties are available to the date and time, and can be altered individually.
|
||||||
|
Most of them are defined in the traits `Datelike` and `Timelike` which you should `use` before.
|
||||||
|
Addition and subtraction is also supported.
|
||||||
|
The following illustrates most supported operations to the date and time:
|
||||||
|
|
||||||
|
~~~~ {.rust}
|
||||||
|
# /* we intentionally fake the datetime...
|
||||||
|
use chrono::{UTC, Local, Datelike, Timelike, Weekday, Duration};
|
||||||
|
|
||||||
|
// assume this returned `2014-11-28T21:45:59.324310806+09:00`:
|
||||||
|
let dt = Local::now();
|
||||||
|
# */ // up to here. we now define a fixed datetime for the illustrative purpose.
|
||||||
|
# use chrono::{UTC, FixedOffset, Offset, Datelike, Timelike, Weekday, Duration};
|
||||||
|
# let dt = FixedOffset::east(9*3600).ymd(2014, 11, 28).and_hms_nano(21, 45, 59, 324310806);
|
||||||
|
|
||||||
|
// property accessors
|
||||||
|
assert_eq!((dt.year(), dt.month(), dt.day()), (2014, 11, 28));
|
||||||
|
assert_eq!((dt.month0(), dt.day0()), (10, 27)); // for unfortunate souls
|
||||||
|
assert_eq!((dt.hour(), dt.minute(), dt.second()), (21, 45, 59));
|
||||||
|
assert_eq!(dt.weekday(), Weekday::Fri);
|
||||||
|
assert_eq!(dt.weekday().number_from_monday(), 5); // Mon=1, ..., Sat=7
|
||||||
|
assert_eq!(dt.ordinal(), 332); // the day of year
|
||||||
|
assert_eq!(dt.num_days_from_ce(), 735565); // the number of days from and including Jan 1, 1
|
||||||
|
|
||||||
|
// offset accessor and manipulation
|
||||||
|
assert_eq!(dt.offset().local_minus_utc(), Duration::hours(9));
|
||||||
|
assert_eq!(dt.with_offset(UTC), UTC.ymd(2014, 11, 28).and_hms_nano(12, 45, 59, 324310806));
|
||||||
|
|
||||||
|
// a sample of property manipulations (validates dynamically)
|
||||||
|
assert_eq!(dt.with_day(29).unwrap().weekday(), Weekday::Sat); // 2014-11-29 is Saturday
|
||||||
|
assert_eq!(dt.with_day(32), None);
|
||||||
|
assert_eq!(dt.with_year(-300).unwrap().num_days_from_ce(), -109606); // November 29, 301 BCE
|
||||||
|
|
||||||
|
// arithmetic operations
|
||||||
|
assert_eq!(UTC.ymd(2014, 11, 14).and_hms(8, 9, 10) - UTC.ymd(2014, 11, 14).and_hms(10, 9, 8),
|
||||||
|
Duration::seconds(-2 * 3600 + 2));
|
||||||
|
assert_eq!(UTC.ymd(1970, 1, 1).and_hms(0, 0, 0) + Duration::seconds(1_000_000_000),
|
||||||
|
UTC.ymd(2001, 9, 9).and_hms(1, 46, 40));
|
||||||
|
assert_eq!(UTC.ymd(1970, 1, 1).and_hms(0, 0, 0) - Duration::seconds(1_000_000_000),
|
||||||
|
UTC.ymd(1938, 4, 24).and_hms(22, 13, 20));
|
||||||
|
~~~~
|
||||||
|
|
||||||
|
Formatting is done via the `format` method,
|
||||||
|
which format is equivalent to the familiar `strftime` format.
|
||||||
|
The default `to_string` method also gives a reasonable representation.
|
||||||
|
|
||||||
|
~~~~ {.rust}
|
||||||
|
use chrono::{UTC, Offset};
|
||||||
|
|
||||||
|
let dt = UTC.ymd(2014, 11, 28).and_hms(12, 0, 9);
|
||||||
|
assert_eq!(dt.format("%Y-%m-%d %H:%M:%S").to_string(), "2014-11-28 12:00:09".into_string());
|
||||||
|
assert_eq!(dt.format("%a %b %e %T %Y").to_string(), "Fri Nov 28 12:00:09 2014".into_string());
|
||||||
|
assert_eq!(dt.format("%a %b %e %T %Y").to_string(), dt.format("%c").to_string());
|
||||||
|
|
||||||
|
assert_eq!(dt.to_string(), "2014-11-28T12:00:09Z".into_string());
|
||||||
|
~~~~
|
||||||
|
|
||||||
|
## Individual date and time
|
||||||
|
|
||||||
|
Chrono also provides an individual date type (`Date`) and time type (`Time`).
|
||||||
|
They also have offsets attached, and have to be constructed via offsets.
|
||||||
|
Most operations available to `DateTime` are also available to `Date` and `Time`
|
||||||
|
whenever appropriate.
|
||||||
|
|
||||||
|
~~~~ {.rust}
|
||||||
|
use chrono::{UTC, Local, Offset, LocalResult, Datelike, Weekday};
|
||||||
|
|
||||||
|
# // these *may* fail, but only very rarely. just rerun the test if you were that unfortunate ;)
|
||||||
|
assert_eq!(UTC::today(), UTC::now().date());
|
||||||
|
assert_eq!(Local::today(), Local::now().date());
|
||||||
|
|
||||||
|
assert_eq!(UTC.ymd(2014, 11, 28).weekday(), Weekday::Fri);
|
||||||
|
assert_eq!(UTC.ymd_opt(2014, 11, 31), LocalResult::None);
|
||||||
|
assert_eq!(UTC.hms_milli(7, 8, 9, 10).format("%H%M%S").to_string(), "070809".into_string());
|
||||||
|
~~~~
|
||||||
|
|
||||||
|
`DateTime` has two methods, `date` and `time`,
|
||||||
|
which return narrow views to its date and time components respectively.
|
||||||
|
|
||||||
|
## Naive date and time
|
||||||
|
|
||||||
|
Chrono provides naive counterparts to `Date`, `Time` and `DateTime`
|
||||||
|
as `NaiveDate`, `NaiveTime` and `NaiveDateTime` respectively.
|
||||||
|
|
||||||
|
They have almost equivalent interfaces as their timezone-aware twins,
|
||||||
|
but are not associated to offsets obviously and can be quite low-level.
|
||||||
|
They are mostly useful for building blocks for higher-level types.
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#![comment = "Date and time library for Rust"]
|
#![comment = "Date and time library for Rust"]
|
||||||
#![license = "MIT"]
|
#![license = "MIT"]
|
||||||
#![doc(html_root_url = "https://lifthrasiir.github.io/rust-chrono/")]
|
#![doc(html_root_url = "https://lifthrasiir.github.io/rust-chrono/")]
|
||||||
|
|
||||||
#![feature(macro_rules)]
|
#![feature(macro_rules, associated_types)]
|
||||||
#![deny(missing_docs)]
|
#![deny(missing_docs)]
|
||||||
|
|
||||||
extern crate "time" as stdtime;
|
extern crate "time" as stdtime;
|
||||||
|
|
|
@ -412,6 +412,11 @@ impl Sub<NaiveDate,Duration> for NaiveDate {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl Sub<Duration,NaiveDate> for NaiveDate {
|
||||||
|
#[inline]
|
||||||
|
fn sub(&self, rhs: &Duration) -> NaiveDate { self.add(&-*rhs) }
|
||||||
|
}
|
||||||
|
|
||||||
impl fmt::Show for NaiveDate {
|
impl fmt::Show for NaiveDate {
|
||||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||||
let year = self.year();
|
let year = self.year();
|
||||||
|
|
|
@ -194,6 +194,11 @@ impl Sub<NaiveDateTime,Duration> for NaiveDateTime {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl Sub<Duration,NaiveDateTime> for NaiveDateTime {
|
||||||
|
#[inline]
|
||||||
|
fn sub(&self, rhs: &Duration) -> NaiveDateTime { self.add(&-*rhs) }
|
||||||
|
}
|
||||||
|
|
||||||
impl fmt::Show for NaiveDateTime {
|
impl fmt::Show for NaiveDateTime {
|
||||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||||
write!(f, "{}T{}", self.date, self.time)
|
write!(f, "{}T{}", self.date, self.time)
|
||||||
|
|
|
@ -212,6 +212,11 @@ impl Sub<NaiveTime,Duration> for NaiveTime {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl Sub<Duration,NaiveTime> for NaiveTime {
|
||||||
|
#[inline]
|
||||||
|
fn sub(&self, rhs: &Duration) -> NaiveTime { self.add(&-*rhs) }
|
||||||
|
}
|
||||||
|
|
||||||
impl fmt::Show for NaiveTime {
|
impl fmt::Show for NaiveTime {
|
||||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||||
let (hour, min, sec) = self.hms();
|
let (hour, min, sec) = self.hms();
|
||||||
|
|
|
@ -21,6 +21,7 @@ use time::Time;
|
||||||
use datetime::DateTime;
|
use datetime::DateTime;
|
||||||
|
|
||||||
/// The conversion result from the local time to the timezone-aware datetime types.
|
/// The conversion result from the local time to the timezone-aware datetime types.
|
||||||
|
#[deriving(Clone, PartialEq, Show)]
|
||||||
pub enum LocalResult<T> {
|
pub enum LocalResult<T> {
|
||||||
/// Given local time representation is invalid.
|
/// Given local time representation is invalid.
|
||||||
/// This can occur when, for example, the positive timezone transition.
|
/// This can occur when, for example, the positive timezone transition.
|
||||||
|
@ -49,6 +50,80 @@ impl<T> LocalResult<T> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl<Off:Offset> LocalResult<Date<Off>> {
|
||||||
|
/// Makes a new `DateTime` from the current date and given `NaiveTime`.
|
||||||
|
/// The offset in the current date is preserved.
|
||||||
|
///
|
||||||
|
/// Propagates any error. Ambiguous result would be discarded.
|
||||||
|
#[inline]
|
||||||
|
pub fn and_time(self, time: NaiveTime) -> LocalResult<DateTime<Off>> {
|
||||||
|
match self {
|
||||||
|
LocalResult::Single(d) => d.and_time(time)
|
||||||
|
.map_or(LocalResult::None, LocalResult::Single),
|
||||||
|
_ => LocalResult::None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Makes a new `DateTime` from the current date, hour, minute and second.
|
||||||
|
/// The offset in the current date is preserved.
|
||||||
|
///
|
||||||
|
/// Propagates any error. Ambiguous result would be discarded.
|
||||||
|
#[inline]
|
||||||
|
pub fn and_hms_opt(self, hour: u32, min: u32, sec: u32) -> LocalResult<DateTime<Off>> {
|
||||||
|
match self {
|
||||||
|
LocalResult::Single(d) => d.and_hms_opt(hour, min, sec)
|
||||||
|
.map_or(LocalResult::None, LocalResult::Single),
|
||||||
|
_ => LocalResult::None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Makes a new `DateTime` from the current date, hour, minute, second and millisecond.
|
||||||
|
/// The millisecond part can exceed 1,000 in order to represent the leap second.
|
||||||
|
/// The offset in the current date is preserved.
|
||||||
|
///
|
||||||
|
/// Propagates any error. Ambiguous result would be discarded.
|
||||||
|
#[inline]
|
||||||
|
pub fn and_hms_milli_opt(self, hour: u32, min: u32, sec: u32,
|
||||||
|
milli: u32) -> LocalResult<DateTime<Off>> {
|
||||||
|
match self {
|
||||||
|
LocalResult::Single(d) => d.and_hms_milli_opt(hour, min, sec, milli)
|
||||||
|
.map_or(LocalResult::None, LocalResult::Single),
|
||||||
|
_ => LocalResult::None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Makes a new `DateTime` from the current date, hour, minute, second and microsecond.
|
||||||
|
/// The microsecond part can exceed 1,000,000 in order to represent the leap second.
|
||||||
|
/// The offset in the current date is preserved.
|
||||||
|
///
|
||||||
|
/// Propagates any error. Ambiguous result would be discarded.
|
||||||
|
#[inline]
|
||||||
|
pub fn and_hms_micro_opt(self, hour: u32, min: u32, sec: u32,
|
||||||
|
micro: u32) -> LocalResult<DateTime<Off>> {
|
||||||
|
match self {
|
||||||
|
LocalResult::Single(d) => d.and_hms_micro_opt(hour, min, sec, micro)
|
||||||
|
.map_or(LocalResult::None, LocalResult::Single),
|
||||||
|
_ => LocalResult::None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Makes a new `DateTime` from the current date, hour, minute, second and nanosecond.
|
||||||
|
/// The nanosecond part can exceed 1,000,000,000 in order to represent the leap second.
|
||||||
|
/// The offset in the current date is preserved.
|
||||||
|
///
|
||||||
|
/// Propagates any error. Ambiguous result would be discarded.
|
||||||
|
#[inline]
|
||||||
|
pub fn and_hms_nano_opt(self, hour: u32, min: u32, sec: u32,
|
||||||
|
nano: u32) -> LocalResult<DateTime<Off>> {
|
||||||
|
match self {
|
||||||
|
LocalResult::Single(d) => d.and_hms_nano_opt(hour, min, sec, nano)
|
||||||
|
.map_or(LocalResult::None, LocalResult::Single),
|
||||||
|
_ => LocalResult::None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
impl<T:fmt::Show> LocalResult<T> {
|
impl<T:fmt::Show> LocalResult<T> {
|
||||||
/// Returns the single unique conversion result, or fails accordingly.
|
/// Returns the single unique conversion result, or fails accordingly.
|
||||||
pub fn unwrap(self) -> T {
|
pub fn unwrap(self) -> T {
|
||||||
|
|
12
src/time.rs
12
src/time.rs
|
@ -35,6 +35,13 @@ impl<Off:Offset> Time<Off> {
|
||||||
&self.offset
|
&self.offset
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Changes the associated offset.
|
||||||
|
/// This does not change the actual `Time` (but will change the string representation).
|
||||||
|
#[inline]
|
||||||
|
pub fn with_offset<Off2:Offset>(&self, offset: Off2) -> Time<Off2> {
|
||||||
|
Time::from_utc(self.time, offset)
|
||||||
|
}
|
||||||
|
|
||||||
/// Formats the time in the specified format string.
|
/// Formats the time in the specified format string.
|
||||||
/// See the `format` module on the supported escape sequences.
|
/// See the `format` module on the supported escape sequences.
|
||||||
#[inline]
|
#[inline]
|
||||||
|
@ -124,6 +131,11 @@ impl<Off:Offset, Off2:Offset> Sub<Time<Off2>,Duration> for Time<Off> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl<Off:Offset> Sub<Duration,Time<Off>> for Time<Off> {
|
||||||
|
#[inline]
|
||||||
|
fn sub(&self, rhs: &Duration) -> Time<Off> { self.add(&-*rhs) }
|
||||||
|
}
|
||||||
|
|
||||||
impl<Off:Offset> fmt::Show for Time<Off> {
|
impl<Off:Offset> fmt::Show for Time<Off> {
|
||||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||||
write!(f, "{}{}", self.local(), self.offset)
|
write!(f, "{}{}", self.local(), self.offset)
|
||||||
|
|
Loading…
Reference in New Issue