// This is a part of rust-chrono. // Copyright (c) 2014-2015, Kang Seonghoon. // See README.md and LICENSE.txt for details. /*! * ISO 8601 date and time. */ use std::{fmt, hash}; use std::cmp::Ordering; use std::ops::{Add, Sub}; use {Weekday, Timelike, Datelike}; use offset::{Offset, FixedOffset}; use duration::Duration; use naive::datetime::NaiveDateTime; use time::Time; use date::Date; use format::{parse, Item, Parsed, ParseResult, DelayedFormat, StrftimeItems}; /// ISO 8601 combined date and time with timezone. #[derive(Clone)] pub struct DateTime { datetime: NaiveDateTime, offset: Off, } impl DateTime { /// Makes a new `DateTime` with given *UTC* datetime and offset. /// The local datetime should be constructed via the `Offset` trait. #[inline] pub fn from_utc(datetime: NaiveDateTime, offset: Off) -> DateTime { DateTime { datetime: datetime, offset: offset } } /// Retrieves a date component. #[inline] pub fn date(&self) -> Date { Date::from_utc(self.datetime.date().clone(), self.offset.clone()) } /// Retrieves a time component. #[inline] pub fn time(&self) -> Time { Time::from_utc(self.datetime.time().clone(), self.offset.clone()) } /// Returns the number of non-leap seconds since January 1, 1970 0:00:00 UTC. #[inline] pub fn num_seconds_from_unix_epoch(&self) -> i64 { self.datetime.num_seconds_from_unix_epoch() } /// Retrieves an associated offset. #[inline] pub fn offset<'a>(&'a self) -> &'a Off { &self.offset } /// Changes the associated offset. /// This does not change the actual `DateTime` (but will change the string representation). #[inline] pub fn with_offset(&self, offset: Off2) -> DateTime { DateTime::from_utc(self.datetime, offset) } /// Adds given `Duration` to the current date and time. /// /// Returns `None` when it will result in overflow. #[inline] pub fn checked_add(self, rhs: Duration) -> Option> { let datetime = try_opt!(self.datetime.checked_add(rhs)); Some(DateTime { datetime: datetime, offset: self.offset }) } /// Subtracts given `Duration` from the current date and time. /// /// Returns `None` when it will result in overflow. #[inline] pub fn checked_sub(self, rhs: Duration) -> Option> { let datetime = try_opt!(self.datetime.checked_sub(rhs)); Some(DateTime { datetime: datetime, offset: self.offset }) } /// Returns a view to the local datetime. fn local(&self) -> NaiveDateTime { self.offset.to_local_datetime(&self.datetime) } } impl DateTime { /// Parses a string with the specified format string and /// returns a new `DateTime` with a parsed `FixedOffset`. /// See the `format::strftime` module on the supported escape sequences. /// /// See also `Offset::datetime_from_str` which gives a local `DateTime` on specific time zone. pub fn from_str(s: &str, fmt: &str) -> ParseResult> { let mut parsed = Parsed::new(); try!(parse(&mut parsed, s, StrftimeItems::new(fmt))); parsed.to_datetime() } } impl DateTime { /// Formats the combined date and time with the specified formatting items. #[inline] pub fn format_with_items<'a, I>(&'a self, items: I) -> DelayedFormat<'a, I> where I: Iterator> + Clone { let local = self.local(); DelayedFormat::new_with_offset(Some(local.date()), Some(local.time()), &self.offset, items) } /// Formats the combined date and time with the specified format string. /// See the `format::strftime` module on the supported escape sequences. #[inline] pub fn format<'a>(&'a self, fmt: &'a str) -> DelayedFormat<'a, StrftimeItems<'a>> { self.format_with_items(StrftimeItems::new(fmt)) } } impl Datelike for DateTime { #[inline] fn year(&self) -> i32 { self.local().year() } #[inline] fn month(&self) -> u32 { self.local().month() } #[inline] fn month0(&self) -> u32 { self.local().month0() } #[inline] fn day(&self) -> u32 { self.local().day() } #[inline] fn day0(&self) -> u32 { self.local().day0() } #[inline] fn ordinal(&self) -> u32 { self.local().ordinal() } #[inline] fn ordinal0(&self) -> u32 { self.local().ordinal0() } #[inline] fn weekday(&self) -> Weekday { self.local().weekday() } #[inline] fn isoweekdate(&self) -> (i32, u32, Weekday) { self.local().isoweekdate() } #[inline] fn with_year(&self, year: i32) -> Option> { self.local().with_year(year) .and_then(|datetime| self.offset.from_local_datetime(&datetime).single()) } #[inline] fn with_month(&self, month: u32) -> Option> { self.local().with_month(month) .and_then(|datetime| self.offset.from_local_datetime(&datetime).single()) } #[inline] fn with_month0(&self, month0: u32) -> Option> { self.local().with_month0(month0) .and_then(|datetime| self.offset.from_local_datetime(&datetime).single()) } #[inline] fn with_day(&self, day: u32) -> Option> { self.local().with_day(day) .and_then(|datetime| self.offset.from_local_datetime(&datetime).single()) } #[inline] fn with_day0(&self, day0: u32) -> Option> { self.local().with_day0(day0) .and_then(|datetime| self.offset.from_local_datetime(&datetime).single()) } #[inline] fn with_ordinal(&self, ordinal: u32) -> Option> { self.local().with_ordinal(ordinal) .and_then(|datetime| self.offset.from_local_datetime(&datetime).single()) } #[inline] fn with_ordinal0(&self, ordinal0: u32) -> Option> { self.local().with_ordinal0(ordinal0) .and_then(|datetime| self.offset.from_local_datetime(&datetime).single()) } } impl Timelike for DateTime { #[inline] fn hour(&self) -> u32 { self.local().hour() } #[inline] fn minute(&self) -> u32 { self.local().minute() } #[inline] fn second(&self) -> u32 { self.local().second() } #[inline] fn nanosecond(&self) -> u32 { self.local().nanosecond() } #[inline] fn with_hour(&self, hour: u32) -> Option> { self.local().with_hour(hour) .and_then(|datetime| self.offset.from_local_datetime(&datetime).single()) } #[inline] fn with_minute(&self, min: u32) -> Option> { self.local().with_minute(min) .and_then(|datetime| self.offset.from_local_datetime(&datetime).single()) } #[inline] fn with_second(&self, sec: u32) -> Option> { self.local().with_second(sec) .and_then(|datetime| self.offset.from_local_datetime(&datetime).single()) } #[inline] fn with_nanosecond(&self, nano: u32) -> Option> { self.local().with_nanosecond(nano) .and_then(|datetime| self.offset.from_local_datetime(&datetime).single()) } } impl PartialEq> for DateTime { fn eq(&self, other: &DateTime) -> bool { self.datetime == other.datetime } } impl Eq for DateTime { } impl PartialOrd for DateTime { fn partial_cmp(&self, other: &DateTime) -> Option { self.datetime.partial_cmp(&other.datetime) } } impl Ord for DateTime { fn cmp(&self, other: &DateTime) -> Ordering { self.datetime.cmp(&other.datetime) } } impl hash::Hash for DateTime { fn hash(&self, state: &mut H) { self.datetime.hash(state) } } impl Add for DateTime { type Output = DateTime; #[inline] fn add(self, rhs: Duration) -> DateTime { self.checked_add(rhs).expect("`DateTime + Duration` overflowed") } } impl Sub> for DateTime { type Output = Duration; #[inline] fn sub(self, rhs: DateTime) -> Duration { self.datetime - rhs.datetime } } impl Sub for DateTime { type Output = DateTime; #[inline] fn sub(self, rhs: Duration) -> DateTime { self.checked_sub(rhs).expect("`DateTime - Duration` overflowed") } } impl fmt::Debug for DateTime { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{:?}{:?}", self.local(), self.offset) } } impl fmt::Display for DateTime { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{} {}", self.local(), self.offset) } } #[cfg(test)] mod tests { use super::DateTime; use Datelike; use duration::Duration; use offset::{Offset, UTC, Local, FixedOffset}; #[test] #[allow(non_snake_case)] fn test_datetime_offset() { let EST = FixedOffset::east(5*60*60); let EDT = FixedOffset::east(4*60*60); assert_eq!(format!("{}", UTC.ymd(2014, 5, 6).and_hms(7, 8, 9)), "2014-05-06 07:08:09 UTC"); assert_eq!(format!("{}", EDT.ymd(2014, 5, 6).and_hms(7, 8, 9)), "2014-05-06 07:08:09 +04:00"); assert_eq!(format!("{:?}", UTC.ymd(2014, 5, 6).and_hms(7, 8, 9)), "2014-05-06T07:08:09Z"); assert_eq!(format!("{:?}", EDT.ymd(2014, 5, 6).and_hms(7, 8, 9)), "2014-05-06T07:08:09+04:00"); assert_eq!(UTC.ymd(2014, 5, 6).and_hms(7, 8, 9), EDT.ymd(2014, 5, 6).and_hms(11, 8, 9)); assert_eq!(UTC.ymd(2014, 5, 6).and_hms(7, 8, 9) + Duration::seconds(3600 + 60 + 1), UTC.ymd(2014, 5, 6).and_hms(8, 9, 10)); assert_eq!(UTC.ymd(2014, 5, 6).and_hms(7, 8, 9) - EDT.ymd(2014, 5, 6).and_hms(10, 11, 12), Duration::seconds(3600 - 3*60 - 3)); assert_eq!(*UTC.ymd(2014, 5, 6).and_hms(7, 8, 9).offset(), UTC); assert_eq!(*EDT.ymd(2014, 5, 6).and_hms(7, 8, 9).offset(), EDT); assert!(*EDT.ymd(2014, 5, 6).and_hms(7, 8, 9).offset() != EST); } #[test] fn test_datetime_from_str() { let ymdhms = |&: y,m,d,h,n,s,off| FixedOffset::east(off).ymd(y,m,d).and_hms(h,n,s); assert_eq!(DateTime::from_str("2014-5-7T12:34:56+09:30", "%Y-%m-%dT%H:%M:%S%z"), Ok(ymdhms(2014, 5, 7, 12, 34, 56, 570*60))); // ignore offset assert!(DateTime::from_str("20140507000000", "%Y%m%d%H%M%S").is_err()); // no offset assert!(DateTime::from_str("Fri, 09 Aug 2013 23:54:35 GMT", "%a, %d %b %Y %H:%M:%S GMT").is_err()); assert_eq!(UTC.datetime_from_str("Fri, 09 Aug 2013 23:54:35 GMT", "%a, %d %b %Y %H:%M:%S GMT"), Ok(UTC.ymd(2013, 8, 9).and_hms(23, 54, 35))); } #[test] fn test_datetime_format_with_local() { // if we are not around the year boundary, local and UTC date should have the same year let dt = Local::now().with_month(5).unwrap(); assert_eq!(dt.format("%Y").to_string(), dt.with_offset(UTC).format("%Y").to_string()); } }