1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Temporal quantification
16 use ops::{Add, Sub, Mul, Div, Neg, FnOnce};
18 use option::Option::{Some, None};
21 use result::Result::{Ok, Err};
23 /// The number of nanoseconds in a microsecond.
24 const NANOS_PER_MICRO: i32 = 1000;
25 /// The number of nanoseconds in a millisecond.
26 const NANOS_PER_MILLI: i32 = 1000_000;
27 /// The number of nanoseconds in seconds.
28 const NANOS_PER_SEC: i32 = 1_000_000_000;
29 /// The number of microseconds per second.
30 const MICROS_PER_SEC: i64 = 1000_000;
31 /// The number of milliseconds per second.
32 const MILLIS_PER_SEC: i64 = 1000;
33 /// The number of seconds in a minute.
34 const SECS_PER_MINUTE: i64 = 60;
35 /// The number of seconds in an hour.
36 const SECS_PER_HOUR: i64 = 3600;
37 /// The number of (non-leap) seconds in days.
38 const SECS_PER_DAY: i64 = 86400;
39 /// The number of (non-leap) seconds in a week.
40 const SECS_PER_WEEK: i64 = 604800;
42 macro_rules! try_opt {
43 ($e:expr) => (match $e { Some(v) => v, None => return None })
47 /// ISO 8601 time duration with nanosecond precision.
48 /// This also allows for the negative duration; see individual methods for details.
49 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
52 nanos: i32, // Always 0 <= nanos < NANOS_PER_SEC
55 /// The minimum possible `Duration`: `i64::MIN` milliseconds.
56 pub const MIN: Duration = Duration {
57 secs: i64::MIN / MILLIS_PER_SEC - 1,
58 nanos: NANOS_PER_SEC + (i64::MIN % MILLIS_PER_SEC) as i32 * NANOS_PER_MILLI
61 /// The maximum possible `Duration`: `i64::MAX` milliseconds.
62 pub const MAX: Duration = Duration {
63 secs: i64::MAX / MILLIS_PER_SEC,
64 nanos: (i64::MAX % MILLIS_PER_SEC) as i32 * NANOS_PER_MILLI
68 /// Makes a new `Duration` with given number of weeks.
69 /// Equivalent to `Duration::seconds(weeks * 7 * 24 * 60 * 60), with overflow checks.
70 /// Panics when the duration is out of bounds.
72 pub fn weeks(weeks: i64) -> Duration {
73 let secs = weeks.checked_mul(SECS_PER_WEEK).expect("Duration::weeks out of bounds");
74 Duration::seconds(secs)
77 /// Makes a new `Duration` with given number of days.
78 /// Equivalent to `Duration::seconds(days * 24 * 60 * 60)` with overflow checks.
79 /// Panics when the duration is out of bounds.
81 pub fn days(days: i64) -> Duration {
82 let secs = days.checked_mul(SECS_PER_DAY).expect("Duration::days out of bounds");
83 Duration::seconds(secs)
86 /// Makes a new `Duration` with given number of hours.
87 /// Equivalent to `Duration::seconds(hours * 60 * 60)` with overflow checks.
88 /// Panics when the duration is out of bounds.
90 pub fn hours(hours: i64) -> Duration {
91 let secs = hours.checked_mul(SECS_PER_HOUR).expect("Duration::hours ouf of bounds");
92 Duration::seconds(secs)
95 /// Makes a new `Duration` with given number of minutes.
96 /// Equivalent to `Duration::seconds(minutes * 60)` with overflow checks.
97 /// Panics when the duration is out of bounds.
99 pub fn minutes(minutes: i64) -> Duration {
100 let secs = minutes.checked_mul(SECS_PER_MINUTE).expect("Duration::minutes out of bounds");
101 Duration::seconds(secs)
104 /// Makes a new `Duration` with given number of seconds.
105 /// Panics when the duration is more than `i64::MAX` milliseconds
106 /// or less than `i64::MIN` milliseconds.
108 pub fn seconds(seconds: i64) -> Duration {
109 let d = Duration { secs: seconds, nanos: 0 };
110 if d < MIN || d > MAX {
111 panic!("Duration::seconds out of bounds");
116 /// Makes a new `Duration` with given number of milliseconds.
118 pub fn milliseconds(milliseconds: i64) -> Duration {
119 let (secs, millis) = div_mod_floor_64(milliseconds, MILLIS_PER_SEC);
120 let nanos = millis as i32 * NANOS_PER_MILLI;
121 Duration { secs: secs, nanos: nanos }
124 /// Makes a new `Duration` with given number of microseconds.
126 pub fn microseconds(microseconds: i64) -> Duration {
127 let (secs, micros) = div_mod_floor_64(microseconds, MICROS_PER_SEC);
128 let nanos = micros as i32 * NANOS_PER_MICRO;
129 Duration { secs: secs, nanos: nanos }
132 /// Makes a new `Duration` with given number of nanoseconds.
134 pub fn nanoseconds(nanos: i64) -> Duration {
135 let (secs, nanos) = div_mod_floor_64(nanos, NANOS_PER_SEC as i64);
136 Duration { secs: secs, nanos: nanos as i32 }
139 /// Runs a closure, returning the duration of time it took to run the
141 pub fn span<F>(f: F) -> Duration where F: FnOnce() {
142 let before = super::precise_time_ns();
144 Duration::nanoseconds((super::precise_time_ns() - before) as i64)
147 /// Returns the total number of whole weeks in the duration.
149 pub fn num_weeks(&self) -> i64 {
153 /// Returns the total number of whole days in the duration.
154 pub fn num_days(&self) -> i64 {
155 self.num_seconds() / SECS_PER_DAY
158 /// Returns the total number of whole hours in the duration.
160 pub fn num_hours(&self) -> i64 {
161 self.num_seconds() / SECS_PER_HOUR
164 /// Returns the total number of whole minutes in the duration.
166 pub fn num_minutes(&self) -> i64 {
167 self.num_seconds() / SECS_PER_MINUTE
170 /// Returns the total number of whole seconds in the duration.
171 pub fn num_seconds(&self) -> i64 {
172 // If secs is negative, nanos should be subtracted from the duration.
173 if self.secs < 0 && self.nanos > 0 {
180 /// Returns the number of nanoseconds such that
181 /// `nanos_mod_sec() + num_seconds() * NANOS_PER_SEC` is the total number of
182 /// nanoseconds in the duration.
183 fn nanos_mod_sec(&self) -> i32 {
184 if self.secs < 0 && self.nanos > 0 {
185 self.nanos - NANOS_PER_SEC
191 /// Returns the total number of whole milliseconds in the duration,
192 pub fn num_milliseconds(&self) -> i64 {
193 // A proper Duration will not overflow, because MIN and MAX are defined
194 // such that the range is exactly i64 milliseconds.
195 let secs_part = self.num_seconds() * MILLIS_PER_SEC;
196 let nanos_part = self.nanos_mod_sec() / NANOS_PER_MILLI;
197 secs_part + nanos_part as i64
200 /// Returns the total number of whole microseconds in the duration,
201 /// or `None` on overflow (exceeding 2^63 microseconds in either direction).
202 pub fn num_microseconds(&self) -> Option<i64> {
203 let secs_part = try_opt!(self.num_seconds().checked_mul(MICROS_PER_SEC));
204 let nanos_part = self.nanos_mod_sec() / NANOS_PER_MICRO;
205 secs_part.checked_add(nanos_part as i64)
208 /// Returns the total number of whole nanoseconds in the duration,
209 /// or `None` on overflow (exceeding 2^63 nanoseconds in either direction).
210 pub fn num_nanoseconds(&self) -> Option<i64> {
211 let secs_part = try_opt!(self.num_seconds().checked_mul(NANOS_PER_SEC as i64));
212 let nanos_part = self.nanos_mod_sec();
213 secs_part.checked_add(nanos_part as i64)
216 /// Add two durations, returning `None` if overflow occured.
217 pub fn checked_add(&self, rhs: &Duration) -> Option<Duration> {
218 let mut secs = try_opt!(self.secs.checked_add(rhs.secs));
219 let mut nanos = self.nanos + rhs.nanos;
220 if nanos >= NANOS_PER_SEC {
221 nanos -= NANOS_PER_SEC;
222 secs = try_opt!(secs.checked_add(1));
224 let d = Duration { secs: secs, nanos: nanos };
225 // Even if d is within the bounds of i64 seconds,
226 // it might still overflow i64 milliseconds.
227 if d < MIN || d > MAX { None } else { Some(d) }
230 /// Subtract two durations, returning `None` if overflow occured.
231 pub fn checked_sub(&self, rhs: &Duration) -> Option<Duration> {
232 let mut secs = try_opt!(self.secs.checked_sub(rhs.secs));
233 let mut nanos = self.nanos - rhs.nanos;
235 nanos += NANOS_PER_SEC;
236 secs = try_opt!(secs.checked_sub(1));
238 let d = Duration { secs: secs, nanos: nanos };
239 // Even if d is within the bounds of i64 seconds,
240 // it might still overflow i64 milliseconds.
241 if d < MIN || d > MAX { None } else { Some(d) }
244 /// The minimum possible `Duration`: `i64::MIN` milliseconds.
246 pub fn min_value() -> Duration { MIN }
248 /// The maximum possible `Duration`: `i64::MAX` milliseconds.
250 pub fn max_value() -> Duration { MAX }
252 /// A duration where the stored seconds and nanoseconds are equal to zero.
254 pub fn zero() -> Duration {
255 Duration { secs: 0, nanos: 0 }
258 /// Returns `true` if the duration equals `Duration::zero()`.
260 pub fn is_zero(&self) -> bool {
261 self.secs == 0 && self.nanos == 0
265 impl Neg for Duration {
266 type Output = Duration;
269 fn neg(self) -> Duration {
271 Duration { secs: -self.secs, nanos: 0 }
273 Duration { secs: -self.secs - 1, nanos: NANOS_PER_SEC - self.nanos }
278 impl Add for Duration {
279 type Output = Duration;
281 fn add(self, rhs: Duration) -> Duration {
282 let mut secs = self.secs + rhs.secs;
283 let mut nanos = self.nanos + rhs.nanos;
284 if nanos >= NANOS_PER_SEC {
285 nanos -= NANOS_PER_SEC;
288 Duration { secs: secs, nanos: nanos }
292 impl Sub for Duration {
293 type Output = Duration;
295 fn sub(self, rhs: Duration) -> Duration {
296 let mut secs = self.secs - rhs.secs;
297 let mut nanos = self.nanos - rhs.nanos;
299 nanos += NANOS_PER_SEC;
302 Duration { secs: secs, nanos: nanos }
306 impl Mul<i32> for Duration {
307 type Output = Duration;
309 fn mul(self, rhs: i32) -> Duration {
310 // Multiply nanoseconds as i64, because it cannot overflow that way.
311 let total_nanos = self.nanos as i64 * rhs as i64;
312 let (extra_secs, nanos) = div_mod_floor_64(total_nanos, NANOS_PER_SEC as i64);
313 let secs = self.secs * rhs as i64 + extra_secs;
314 Duration { secs: secs, nanos: nanos as i32 }
318 impl Div<i32> for Duration {
319 type Output = Duration;
321 fn div(self, rhs: i32) -> Duration {
322 let mut secs = self.secs / rhs as i64;
323 let carry = self.secs - secs * rhs as i64;
324 let extra_nanos = carry * NANOS_PER_SEC as i64 / rhs as i64;
325 let mut nanos = self.nanos / rhs + extra_nanos as i32;
326 if nanos >= NANOS_PER_SEC {
327 nanos -= NANOS_PER_SEC;
331 nanos += NANOS_PER_SEC;
334 Duration { secs: secs, nanos: nanos }
338 impl fmt::Show for Duration {
339 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
340 // technically speaking, negative duration is not valid ISO 8601,
341 // but we need to print it anyway.
342 let (abs, sign) = if self.secs < 0 { (-*self, "-") } else { (*self, "") };
344 let days = abs.secs / SECS_PER_DAY;
345 let secs = abs.secs - days * SECS_PER_DAY;
346 let hasdate = days != 0;
347 let hastime = (secs != 0 || abs.nanos != 0) || !hasdate;
349 try!(write!(f, "{}P", sign));
352 try!(write!(f, "{}D", days));
356 try!(write!(f, "T{}S", secs));
357 } else if abs.nanos % NANOS_PER_MILLI == 0 {
358 try!(write!(f, "T{}.{:03}S", secs, abs.nanos / NANOS_PER_MILLI));
359 } else if abs.nanos % NANOS_PER_MICRO == 0 {
360 try!(write!(f, "T{}.{:06}S", secs, abs.nanos / NANOS_PER_MICRO));
362 try!(write!(f, "T{}.{:09}S", secs, abs.nanos));
369 // Copied from libnum
371 fn div_mod_floor_64(this: i64, other: i64) -> (i64, i64) {
372 (div_floor_64(this, other), mod_floor_64(this, other))
376 fn div_floor_64(this: i64, other: i64) -> i64 {
377 match div_rem_64(this, other) {
378 (d, r) if (r > 0 && other < 0)
379 || (r < 0 && other > 0) => d - 1,
385 fn mod_floor_64(this: i64, other: i64) -> i64 {
387 r if (r > 0 && other < 0)
388 || (r < 0 && other > 0) => r + other,
394 fn div_rem_64(this: i64, other: i64) -> (i64, i64) {
395 (this / other, this % other)
400 use super::{Duration, MIN, MAX};
402 use option::Option::{Some, None};
403 use string::ToString;
407 assert!(Duration::seconds(1) != Duration::zero());
408 assert_eq!(Duration::seconds(1) + Duration::seconds(2), Duration::seconds(3));
409 assert_eq!(Duration::seconds(86399) + Duration::seconds(4),
410 Duration::days(1) + Duration::seconds(3));
411 assert_eq!(Duration::days(10) - Duration::seconds(1000), Duration::seconds(863000));
412 assert_eq!(Duration::days(10) - Duration::seconds(1000000), Duration::seconds(-136000));
413 assert_eq!(Duration::days(2) + Duration::seconds(86399) +
414 Duration::nanoseconds(1234567890),
415 Duration::days(3) + Duration::nanoseconds(234567890));
416 assert_eq!(-Duration::days(3), Duration::days(-3));
417 assert_eq!(-(Duration::days(3) + Duration::seconds(70)),
418 Duration::days(-4) + Duration::seconds(86400-70));
422 fn test_duration_num_days() {
423 assert_eq!(Duration::zero().num_days(), 0);
424 assert_eq!(Duration::days(1).num_days(), 1);
425 assert_eq!(Duration::days(-1).num_days(), -1);
426 assert_eq!(Duration::seconds(86399).num_days(), 0);
427 assert_eq!(Duration::seconds(86401).num_days(), 1);
428 assert_eq!(Duration::seconds(-86399).num_days(), 0);
429 assert_eq!(Duration::seconds(-86401).num_days(), -1);
430 assert_eq!(Duration::days(i32::MAX as i64).num_days(), i32::MAX as i64);
431 assert_eq!(Duration::days(i32::MIN as i64).num_days(), i32::MIN as i64);
435 fn test_duration_num_seconds() {
436 assert_eq!(Duration::zero().num_seconds(), 0);
437 assert_eq!(Duration::seconds(1).num_seconds(), 1);
438 assert_eq!(Duration::seconds(-1).num_seconds(), -1);
439 assert_eq!(Duration::milliseconds(999).num_seconds(), 0);
440 assert_eq!(Duration::milliseconds(1001).num_seconds(), 1);
441 assert_eq!(Duration::milliseconds(-999).num_seconds(), 0);
442 assert_eq!(Duration::milliseconds(-1001).num_seconds(), -1);
446 fn test_duration_num_milliseconds() {
447 assert_eq!(Duration::zero().num_milliseconds(), 0);
448 assert_eq!(Duration::milliseconds(1).num_milliseconds(), 1);
449 assert_eq!(Duration::milliseconds(-1).num_milliseconds(), -1);
450 assert_eq!(Duration::microseconds(999).num_milliseconds(), 0);
451 assert_eq!(Duration::microseconds(1001).num_milliseconds(), 1);
452 assert_eq!(Duration::microseconds(-999).num_milliseconds(), 0);
453 assert_eq!(Duration::microseconds(-1001).num_milliseconds(), -1);
454 assert_eq!(Duration::milliseconds(i64::MAX).num_milliseconds(), i64::MAX);
455 assert_eq!(Duration::milliseconds(i64::MIN).num_milliseconds(), i64::MIN);
456 assert_eq!(MAX.num_milliseconds(), i64::MAX);
457 assert_eq!(MIN.num_milliseconds(), i64::MIN);
461 fn test_duration_num_microseconds() {
462 assert_eq!(Duration::zero().num_microseconds(), Some(0));
463 assert_eq!(Duration::microseconds(1).num_microseconds(), Some(1));
464 assert_eq!(Duration::microseconds(-1).num_microseconds(), Some(-1));
465 assert_eq!(Duration::nanoseconds(999).num_microseconds(), Some(0));
466 assert_eq!(Duration::nanoseconds(1001).num_microseconds(), Some(1));
467 assert_eq!(Duration::nanoseconds(-999).num_microseconds(), Some(0));
468 assert_eq!(Duration::nanoseconds(-1001).num_microseconds(), Some(-1));
469 assert_eq!(Duration::microseconds(i64::MAX).num_microseconds(), Some(i64::MAX));
470 assert_eq!(Duration::microseconds(i64::MIN).num_microseconds(), Some(i64::MIN));
471 assert_eq!(MAX.num_microseconds(), None);
472 assert_eq!(MIN.num_microseconds(), None);
475 const MICROS_PER_DAY: i64 = 86400_000_000;
476 assert_eq!(Duration::days(i64::MAX / MICROS_PER_DAY).num_microseconds(),
477 Some(i64::MAX / MICROS_PER_DAY * MICROS_PER_DAY));
478 assert_eq!(Duration::days(i64::MIN / MICROS_PER_DAY).num_microseconds(),
479 Some(i64::MIN / MICROS_PER_DAY * MICROS_PER_DAY));
480 assert_eq!(Duration::days(i64::MAX / MICROS_PER_DAY + 1).num_microseconds(), None);
481 assert_eq!(Duration::days(i64::MIN / MICROS_PER_DAY - 1).num_microseconds(), None);
485 fn test_duration_num_nanoseconds() {
486 assert_eq!(Duration::zero().num_nanoseconds(), Some(0));
487 assert_eq!(Duration::nanoseconds(1).num_nanoseconds(), Some(1));
488 assert_eq!(Duration::nanoseconds(-1).num_nanoseconds(), Some(-1));
489 assert_eq!(Duration::nanoseconds(i64::MAX).num_nanoseconds(), Some(i64::MAX));
490 assert_eq!(Duration::nanoseconds(i64::MIN).num_nanoseconds(), Some(i64::MIN));
491 assert_eq!(MAX.num_nanoseconds(), None);
492 assert_eq!(MIN.num_nanoseconds(), None);
495 const NANOS_PER_DAY: i64 = 86400_000_000_000;
496 assert_eq!(Duration::days(i64::MAX / NANOS_PER_DAY).num_nanoseconds(),
497 Some(i64::MAX / NANOS_PER_DAY * NANOS_PER_DAY));
498 assert_eq!(Duration::days(i64::MIN / NANOS_PER_DAY).num_nanoseconds(),
499 Some(i64::MIN / NANOS_PER_DAY * NANOS_PER_DAY));
500 assert_eq!(Duration::days(i64::MAX / NANOS_PER_DAY + 1).num_nanoseconds(), None);
501 assert_eq!(Duration::days(i64::MIN / NANOS_PER_DAY - 1).num_nanoseconds(), None);
505 fn test_duration_checked_ops() {
506 assert_eq!(Duration::milliseconds(i64::MAX - 1).checked_add(&Duration::microseconds(999)),
507 Some(Duration::milliseconds(i64::MAX - 2) + Duration::microseconds(1999)));
508 assert!(Duration::milliseconds(i64::MAX).checked_add(&Duration::microseconds(1000))
511 assert_eq!(Duration::milliseconds(i64::MIN).checked_sub(&Duration::milliseconds(0)),
512 Some(Duration::milliseconds(i64::MIN)));
513 assert!(Duration::milliseconds(i64::MIN).checked_sub(&Duration::milliseconds(1))
518 fn test_duration_mul() {
519 assert_eq!(Duration::zero() * i32::MAX, Duration::zero());
520 assert_eq!(Duration::zero() * i32::MIN, Duration::zero());
521 assert_eq!(Duration::nanoseconds(1) * 0, Duration::zero());
522 assert_eq!(Duration::nanoseconds(1) * 1, Duration::nanoseconds(1));
523 assert_eq!(Duration::nanoseconds(1) * 1_000_000_000, Duration::seconds(1));
524 assert_eq!(Duration::nanoseconds(1) * -1_000_000_000, -Duration::seconds(1));
525 assert_eq!(-Duration::nanoseconds(1) * 1_000_000_000, -Duration::seconds(1));
526 assert_eq!(Duration::nanoseconds(30) * 333_333_333,
527 Duration::seconds(10) - Duration::nanoseconds(10));
528 assert_eq!((Duration::nanoseconds(1) + Duration::seconds(1) + Duration::days(1)) * 3,
529 Duration::nanoseconds(3) + Duration::seconds(3) + Duration::days(3));
530 assert_eq!(Duration::milliseconds(1500) * -2, Duration::seconds(-3));
531 assert_eq!(Duration::milliseconds(-1500) * 2, Duration::seconds(-3));
535 fn test_duration_div() {
536 assert_eq!(Duration::zero() / i32::MAX, Duration::zero());
537 assert_eq!(Duration::zero() / i32::MIN, Duration::zero());
538 assert_eq!(Duration::nanoseconds(123_456_789) / 1, Duration::nanoseconds(123_456_789));
539 assert_eq!(Duration::nanoseconds(123_456_789) / -1, -Duration::nanoseconds(123_456_789));
540 assert_eq!(-Duration::nanoseconds(123_456_789) / -1, Duration::nanoseconds(123_456_789));
541 assert_eq!(-Duration::nanoseconds(123_456_789) / 1, -Duration::nanoseconds(123_456_789));
542 assert_eq!(Duration::seconds(1) / 3, Duration::nanoseconds(333_333_333));
543 assert_eq!(Duration::seconds(4) / 3, Duration::nanoseconds(1_333_333_333));
544 assert_eq!(Duration::seconds(-1) / 2, Duration::milliseconds(-500));
545 assert_eq!(Duration::seconds(1) / -2, Duration::milliseconds(-500));
546 assert_eq!(Duration::seconds(-1) / -2, Duration::milliseconds(500));
547 assert_eq!(Duration::seconds(-4) / 3, Duration::nanoseconds(-1_333_333_333));
548 assert_eq!(Duration::seconds(-4) / -3, Duration::nanoseconds(1_333_333_333));
552 fn test_duration_fmt() {
553 assert_eq!(Duration::zero().to_string(), "PT0S");
554 assert_eq!(Duration::days(42).to_string(), "P42D");
555 assert_eq!(Duration::days(-42).to_string(), "-P42D");
556 assert_eq!(Duration::seconds(42).to_string(), "PT42S");
557 assert_eq!(Duration::milliseconds(42).to_string(), "PT0.042S");
558 assert_eq!(Duration::microseconds(42).to_string(), "PT0.000042S");
559 assert_eq!(Duration::nanoseconds(42).to_string(), "PT0.000000042S");
560 assert_eq!((Duration::days(7) + Duration::milliseconds(6543)).to_string(),
562 assert_eq!(Duration::seconds(-86401).to_string(), "-P1DT1S");
563 assert_eq!(Duration::nanoseconds(-1).to_string(), "-PT0.000000001S");
565 // the format specifier should have no effect on `Duration`
566 assert_eq!(format!("{:30}", Duration::days(1) + Duration::milliseconds(2345)),