]> git.lizzy.rs Git - rust.git/blob - src/libcore/time.rs
Add issue number
[rust.git] / src / libcore / time.rs
1 // Copyright 2012-2017 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.
4 //
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.
10 #![stable(feature = "duration_core", since = "1.25.0")]
11
12 //! Temporal quantification.
13 //!
14 //! Example:
15 //!
16 //! ```
17 //! use std::time::Duration;
18 //!
19 //! let five_seconds = Duration::new(5, 0);
20 //! // both declarations are equivalent
21 //! assert_eq!(Duration::new(5, 0), Duration::from_secs(5));
22 //! ```
23
24 use iter::Sum;
25 use ops::{Add, Sub, Mul, Div, AddAssign, SubAssign, MulAssign, DivAssign};
26
27 const NANOS_PER_SEC: u32 = 1_000_000_000;
28 const NANOS_PER_MILLI: u32 = 1_000_000;
29 const NANOS_PER_MICRO: u32 = 1_000;
30 const MILLIS_PER_SEC: u64 = 1_000;
31 const MICROS_PER_SEC: u64 = 1_000_000;
32
33 /// A `Duration` type to represent a span of time, typically used for system
34 /// timeouts.
35 ///
36 /// Each `Duration` is composed of a whole number of seconds and a fractional part
37 /// represented in nanoseconds.  If the underlying system does not support
38 /// nanosecond-level precision, APIs binding a system timeout will typically round up
39 /// the number of nanoseconds.
40 ///
41 /// `Duration`s implement many common traits, including [`Add`], [`Sub`], and other
42 /// [`ops`] traits.
43 ///
44 /// [`Add`]: ../../std/ops/trait.Add.html
45 /// [`Sub`]: ../../std/ops/trait.Sub.html
46 /// [`ops`]: ../../std/ops/index.html
47 ///
48 /// # Examples
49 ///
50 /// ```
51 /// use std::time::Duration;
52 ///
53 /// let five_seconds = Duration::new(5, 0);
54 /// let five_seconds_and_five_nanos = five_seconds + Duration::new(0, 5);
55 ///
56 /// assert_eq!(five_seconds_and_five_nanos.as_secs(), 5);
57 /// assert_eq!(five_seconds_and_five_nanos.subsec_nanos(), 5);
58 ///
59 /// let ten_millis = Duration::from_millis(10);
60 /// ```
61 #[stable(feature = "duration", since = "1.3.0")]
62 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash, Default)]
63 pub struct Duration {
64     secs: u64,
65     nanos: u32, // Always 0 <= nanos < NANOS_PER_SEC
66 }
67
68 impl Duration {
69     /// Creates a new `Duration` from the specified number of whole seconds and
70     /// additional nanoseconds.
71     ///
72     /// If the number of nanoseconds is greater than 1 billion (the number of
73     /// nanoseconds in a second), then it will carry over into the seconds provided.
74     ///
75     /// # Panics
76     ///
77     /// This constructor will panic if the carry from the nanoseconds overflows
78     /// the seconds counter.
79     ///
80     /// # Examples
81     ///
82     /// ```
83     /// use std::time::Duration;
84     ///
85     /// let five_seconds = Duration::new(5, 0);
86     /// ```
87     #[stable(feature = "duration", since = "1.3.0")]
88     #[inline]
89     pub fn new(secs: u64, nanos: u32) -> Duration {
90         let secs = secs.checked_add((nanos / NANOS_PER_SEC) as u64)
91             .expect("overflow in Duration::new");
92         let nanos = nanos % NANOS_PER_SEC;
93         Duration { secs: secs, nanos: nanos }
94     }
95
96     /// Creates a new `Duration` from the specified number of whole seconds.
97     ///
98     /// # Examples
99     ///
100     /// ```
101     /// use std::time::Duration;
102     ///
103     /// let duration = Duration::from_secs(5);
104     ///
105     /// assert_eq!(5, duration.as_secs());
106     /// assert_eq!(0, duration.subsec_nanos());
107     /// ```
108     #[stable(feature = "duration", since = "1.3.0")]
109     #[inline]
110     pub const fn from_secs(secs: u64) -> Duration {
111         Duration { secs: secs, nanos: 0 }
112     }
113
114     /// Creates a new `Duration` from the specified number of milliseconds.
115     ///
116     /// # Examples
117     ///
118     /// ```
119     /// use std::time::Duration;
120     ///
121     /// let duration = Duration::from_millis(2569);
122     ///
123     /// assert_eq!(2, duration.as_secs());
124     /// assert_eq!(569_000_000, duration.subsec_nanos());
125     /// ```
126     #[stable(feature = "duration", since = "1.3.0")]
127     #[inline]
128     pub const fn from_millis(millis: u64) -> Duration {
129         Duration {
130             secs: millis / MILLIS_PER_SEC,
131             nanos: ((millis % MILLIS_PER_SEC) as u32) * NANOS_PER_MILLI,
132         }
133     }
134
135     /// Creates a new `Duration` from the specified number of microseconds.
136     ///
137     /// # Examples
138     ///
139     /// ```
140     /// use std::time::Duration;
141     ///
142     /// let duration = Duration::from_micros(1_000_002);
143     ///
144     /// assert_eq!(1, duration.as_secs());
145     /// assert_eq!(2000, duration.subsec_nanos());
146     /// ```
147     #[stable(feature = "duration_from_micros", since = "1.27.0")]
148     #[inline]
149     pub const fn from_micros(micros: u64) -> Duration {
150         Duration {
151             secs: micros / MICROS_PER_SEC,
152             nanos: ((micros % MICROS_PER_SEC) as u32) * NANOS_PER_MICRO,
153         }
154     }
155
156     /// Creates a new `Duration` from the specified number of nanoseconds.
157     ///
158     /// # Examples
159     ///
160     /// ```
161     /// use std::time::Duration;
162     ///
163     /// let duration = Duration::from_nanos(1_000_000_123);
164     ///
165     /// assert_eq!(1, duration.as_secs());
166     /// assert_eq!(123, duration.subsec_nanos());
167     /// ```
168     #[stable(feature = "duration_extras", since = "1.27.0")]
169     #[inline]
170     pub const fn from_nanos(nanos: u64) -> Duration {
171         Duration {
172             secs: nanos / (NANOS_PER_SEC as u64),
173             nanos: (nanos % (NANOS_PER_SEC as u64)) as u32,
174         }
175     }
176
177     /// Returns the number of _whole_ seconds contained by this `Duration`.
178     ///
179     /// The returned value does not include the fractional (nanosecond) part of the
180     /// duration, which can be obtained using [`subsec_nanos`].
181     ///
182     /// # Examples
183     ///
184     /// ```
185     /// use std::time::Duration;
186     ///
187     /// let duration = Duration::new(5, 730023852);
188     /// assert_eq!(duration.as_secs(), 5);
189     /// ```
190     ///
191     /// To determine the total number of seconds represented by the `Duration`,
192     /// use `as_secs` in combination with [`subsec_nanos`]:
193     ///
194     /// ```
195     /// use std::time::Duration;
196     ///
197     /// let duration = Duration::new(5, 730023852);
198     ///
199     /// assert_eq!(5.730023852,
200     ///            duration.as_secs() as f64
201     ///            + duration.subsec_nanos() as f64 * 1e-9);
202     /// ```
203     ///
204     /// [`subsec_nanos`]: #method.subsec_nanos
205     #[stable(feature = "duration", since = "1.3.0")]
206     #[inline]
207     pub fn as_secs(&self) -> u64 { self.secs }
208
209     /// Returns the fractional part of this `Duration`, in milliseconds.
210     ///
211     /// This method does **not** return the length of the duration when
212     /// represented by milliseconds. The returned number always represents a
213     /// fractional portion of a second (i.e. it is less than one thousand).
214     ///
215     /// # Examples
216     ///
217     /// ```
218     /// use std::time::Duration;
219     ///
220     /// let duration = Duration::from_millis(5432);
221     /// assert_eq!(duration.as_secs(), 5);
222     /// assert_eq!(duration.subsec_millis(), 432);
223     /// ```
224     #[stable(feature = "duration_extras", since = "1.27.0")]
225     #[inline]
226     pub fn subsec_millis(&self) -> u32 { self.nanos / NANOS_PER_MILLI }
227
228     /// Returns the fractional part of this `Duration`, in microseconds.
229     ///
230     /// This method does **not** return the length of the duration when
231     /// represented by microseconds. The returned number always represents a
232     /// fractional portion of a second (i.e. it is less than one million).
233     ///
234     /// # Examples
235     ///
236     /// ```
237     /// use std::time::Duration;
238     ///
239     /// let duration = Duration::from_micros(1_234_567);
240     /// assert_eq!(duration.as_secs(), 1);
241     /// assert_eq!(duration.subsec_micros(), 234_567);
242     /// ```
243     #[stable(feature = "duration_extras", since = "1.27.0")]
244     #[inline]
245     pub fn subsec_micros(&self) -> u32 { self.nanos / NANOS_PER_MICRO }
246
247     /// Returns the fractional part of this `Duration`, in nanoseconds.
248     ///
249     /// This method does **not** return the length of the duration when
250     /// represented by nanoseconds. The returned number always represents a
251     /// fractional portion of a second (i.e. it is less than one billion).
252     ///
253     /// # Examples
254     ///
255     /// ```
256     /// use std::time::Duration;
257     ///
258     /// let duration = Duration::from_millis(5010);
259     /// assert_eq!(duration.as_secs(), 5);
260     /// assert_eq!(duration.subsec_nanos(), 10_000_000);
261     /// ```
262     #[stable(feature = "duration", since = "1.3.0")]
263     #[inline]
264     pub fn subsec_nanos(&self) -> u32 { self.nanos }
265
266     /// Returns the total number of nanoseconds contained by this `Duration`.
267     ///
268     /// # Examples
269     ///
270     /// ```
271     /// use std::time::Duration;
272     ///
273     /// let duration = Duration::new(5, 730023852);
274     /// assert_eq!(duration.as_nanos(), 5730023852);
275     /// ```
276     #[unstable(feature = "duration_nanos", issue = "50167")]
277     #[inline]
278     pub fn as_nanos(&self) -> u128 {
279         self.secs as u128 * NANOS_PER_SEC as u128 + self.nanos as u128
280     }
281
282     /// Checked `Duration` addition. Computes `self + other`, returning [`None`]
283     /// if overflow occurred.
284     ///
285     /// [`None`]: ../../std/option/enum.Option.html#variant.None
286     ///
287     /// # Examples
288     ///
289     /// Basic usage:
290     ///
291     /// ```
292     /// use std::time::Duration;
293     ///
294     /// assert_eq!(Duration::new(0, 0).checked_add(Duration::new(0, 1)), Some(Duration::new(0, 1)));
295     /// assert_eq!(Duration::new(1, 0).checked_add(Duration::new(std::u64::MAX, 0)), None);
296     /// ```
297     #[stable(feature = "duration_checked_ops", since = "1.16.0")]
298     #[inline]
299     pub fn checked_add(self, rhs: Duration) -> Option<Duration> {
300         if let Some(mut secs) = self.secs.checked_add(rhs.secs) {
301             let mut nanos = self.nanos + rhs.nanos;
302             if nanos >= NANOS_PER_SEC {
303                 nanos -= NANOS_PER_SEC;
304                 if let Some(new_secs) = secs.checked_add(1) {
305                     secs = new_secs;
306                 } else {
307                     return None;
308                 }
309             }
310             debug_assert!(nanos < NANOS_PER_SEC);
311             Some(Duration {
312                 secs,
313                 nanos,
314             })
315         } else {
316             None
317         }
318     }
319
320     /// Checked `Duration` subtraction. Computes `self - other`, returning [`None`]
321     /// if the result would be negative or if overflow occurred.
322     ///
323     /// [`None`]: ../../std/option/enum.Option.html#variant.None
324     ///
325     /// # Examples
326     ///
327     /// Basic usage:
328     ///
329     /// ```
330     /// use std::time::Duration;
331     ///
332     /// assert_eq!(Duration::new(0, 1).checked_sub(Duration::new(0, 0)), Some(Duration::new(0, 1)));
333     /// assert_eq!(Duration::new(0, 0).checked_sub(Duration::new(0, 1)), None);
334     /// ```
335     #[stable(feature = "duration_checked_ops", since = "1.16.0")]
336     #[inline]
337     pub fn checked_sub(self, rhs: Duration) -> Option<Duration> {
338         if let Some(mut secs) = self.secs.checked_sub(rhs.secs) {
339             let nanos = if self.nanos >= rhs.nanos {
340                 self.nanos - rhs.nanos
341             } else {
342                 if let Some(sub_secs) = secs.checked_sub(1) {
343                     secs = sub_secs;
344                     self.nanos + NANOS_PER_SEC - rhs.nanos
345                 } else {
346                     return None;
347                 }
348             };
349             debug_assert!(nanos < NANOS_PER_SEC);
350             Some(Duration { secs: secs, nanos: nanos })
351         } else {
352             None
353         }
354     }
355
356     /// Checked `Duration` multiplication. Computes `self * other`, returning
357     /// [`None`] if overflow occurred.
358     ///
359     /// [`None`]: ../../std/option/enum.Option.html#variant.None
360     ///
361     /// # Examples
362     ///
363     /// Basic usage:
364     ///
365     /// ```
366     /// use std::time::Duration;
367     ///
368     /// assert_eq!(Duration::new(0, 500_000_001).checked_mul(2), Some(Duration::new(1, 2)));
369     /// assert_eq!(Duration::new(std::u64::MAX - 1, 0).checked_mul(2), None);
370     /// ```
371     #[stable(feature = "duration_checked_ops", since = "1.16.0")]
372     #[inline]
373     pub fn checked_mul(self, rhs: u32) -> Option<Duration> {
374         // Multiply nanoseconds as u64, because it cannot overflow that way.
375         let total_nanos = self.nanos as u64 * rhs as u64;
376         let extra_secs = total_nanos / (NANOS_PER_SEC as u64);
377         let nanos = (total_nanos % (NANOS_PER_SEC as u64)) as u32;
378         if let Some(secs) = self.secs
379             .checked_mul(rhs as u64)
380             .and_then(|s| s.checked_add(extra_secs)) {
381             debug_assert!(nanos < NANOS_PER_SEC);
382             Some(Duration {
383                 secs,
384                 nanos,
385             })
386         } else {
387             None
388         }
389     }
390
391     /// Checked `Duration` division. Computes `self / other`, returning [`None`]
392     /// if `other == 0`.
393     ///
394     /// [`None`]: ../../std/option/enum.Option.html#variant.None
395     ///
396     /// # Examples
397     ///
398     /// Basic usage:
399     ///
400     /// ```
401     /// use std::time::Duration;
402     ///
403     /// assert_eq!(Duration::new(2, 0).checked_div(2), Some(Duration::new(1, 0)));
404     /// assert_eq!(Duration::new(1, 0).checked_div(2), Some(Duration::new(0, 500_000_000)));
405     /// assert_eq!(Duration::new(2, 0).checked_div(0), None);
406     /// ```
407     #[stable(feature = "duration_checked_ops", since = "1.16.0")]
408     #[inline]
409     pub fn checked_div(self, rhs: u32) -> Option<Duration> {
410         if rhs != 0 {
411             let secs = self.secs / (rhs as u64);
412             let carry = self.secs - secs * (rhs as u64);
413             let extra_nanos = carry * (NANOS_PER_SEC as u64) / (rhs as u64);
414             let nanos = self.nanos / rhs + (extra_nanos as u32);
415             debug_assert!(nanos < NANOS_PER_SEC);
416             Some(Duration { secs: secs, nanos: nanos })
417         } else {
418             None
419         }
420     }
421 }
422
423 #[stable(feature = "duration", since = "1.3.0")]
424 impl Add for Duration {
425     type Output = Duration;
426
427     fn add(self, rhs: Duration) -> Duration {
428         self.checked_add(rhs).expect("overflow when adding durations")
429     }
430 }
431
432 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
433 impl AddAssign for Duration {
434     fn add_assign(&mut self, rhs: Duration) {
435         *self = *self + rhs;
436     }
437 }
438
439 #[stable(feature = "duration", since = "1.3.0")]
440 impl Sub for Duration {
441     type Output = Duration;
442
443     fn sub(self, rhs: Duration) -> Duration {
444         self.checked_sub(rhs).expect("overflow when subtracting durations")
445     }
446 }
447
448 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
449 impl SubAssign for Duration {
450     fn sub_assign(&mut self, rhs: Duration) {
451         *self = *self - rhs;
452     }
453 }
454
455 #[stable(feature = "duration", since = "1.3.0")]
456 impl Mul<u32> for Duration {
457     type Output = Duration;
458
459     fn mul(self, rhs: u32) -> Duration {
460         self.checked_mul(rhs).expect("overflow when multiplying duration by scalar")
461     }
462 }
463
464 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
465 impl MulAssign<u32> for Duration {
466     fn mul_assign(&mut self, rhs: u32) {
467         *self = *self * rhs;
468     }
469 }
470
471 #[stable(feature = "duration", since = "1.3.0")]
472 impl Div<u32> for Duration {
473     type Output = Duration;
474
475     fn div(self, rhs: u32) -> Duration {
476         self.checked_div(rhs).expect("divide by zero error when dividing duration by scalar")
477     }
478 }
479
480 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
481 impl DivAssign<u32> for Duration {
482     fn div_assign(&mut self, rhs: u32) {
483         *self = *self / rhs;
484     }
485 }
486
487 #[stable(feature = "duration_sum", since = "1.16.0")]
488 impl Sum for Duration {
489     fn sum<I: Iterator<Item=Duration>>(iter: I) -> Duration {
490         iter.fold(Duration::new(0, 0), |a, b| a + b)
491     }
492 }
493
494 #[stable(feature = "duration_sum", since = "1.16.0")]
495 impl<'a> Sum<&'a Duration> for Duration {
496     fn sum<I: Iterator<Item=&'a Duration>>(iter: I) -> Duration {
497         iter.fold(Duration::new(0, 0), |a, b| a + *b)
498     }
499 }
500
501 #[cfg(test)]
502 mod tests {
503     use super::Duration;
504
505     #[test]
506     fn creation() {
507         assert!(Duration::from_secs(1) != Duration::from_secs(0));
508         assert_eq!(Duration::from_secs(1) + Duration::from_secs(2),
509                    Duration::from_secs(3));
510         assert_eq!(Duration::from_millis(10) + Duration::from_secs(4),
511                    Duration::new(4, 10 * 1_000_000));
512         assert_eq!(Duration::from_millis(4000), Duration::new(4, 0));
513     }
514
515     #[test]
516     fn secs() {
517         assert_eq!(Duration::new(0, 0).as_secs(), 0);
518         assert_eq!(Duration::from_secs(1).as_secs(), 1);
519         assert_eq!(Duration::from_millis(999).as_secs(), 0);
520         assert_eq!(Duration::from_millis(1001).as_secs(), 1);
521     }
522
523     #[test]
524     fn nanos() {
525         assert_eq!(Duration::new(0, 0).subsec_nanos(), 0);
526         assert_eq!(Duration::new(0, 5).subsec_nanos(), 5);
527         assert_eq!(Duration::new(0, 1_000_000_001).subsec_nanos(), 1);
528         assert_eq!(Duration::from_secs(1).subsec_nanos(), 0);
529         assert_eq!(Duration::from_millis(999).subsec_nanos(), 999 * 1_000_000);
530         assert_eq!(Duration::from_millis(1001).subsec_nanos(), 1 * 1_000_000);
531     }
532
533     #[test]
534     fn add() {
535         assert_eq!(Duration::new(0, 0) + Duration::new(0, 1),
536                    Duration::new(0, 1));
537         assert_eq!(Duration::new(0, 500_000_000) + Duration::new(0, 500_000_001),
538                    Duration::new(1, 1));
539     }
540
541     #[test]
542     fn checked_add() {
543         assert_eq!(Duration::new(0, 0).checked_add(Duration::new(0, 1)),
544                    Some(Duration::new(0, 1)));
545         assert_eq!(Duration::new(0, 500_000_000).checked_add(Duration::new(0, 500_000_001)),
546                    Some(Duration::new(1, 1)));
547         assert_eq!(Duration::new(1, 0).checked_add(Duration::new(::u64::MAX, 0)), None);
548     }
549
550     #[test]
551     fn sub() {
552         assert_eq!(Duration::new(0, 1) - Duration::new(0, 0),
553                    Duration::new(0, 1));
554         assert_eq!(Duration::new(0, 500_000_001) - Duration::new(0, 500_000_000),
555                    Duration::new(0, 1));
556         assert_eq!(Duration::new(1, 0) - Duration::new(0, 1),
557                    Duration::new(0, 999_999_999));
558     }
559
560     #[test]
561     fn checked_sub() {
562         let zero = Duration::new(0, 0);
563         let one_nano = Duration::new(0, 1);
564         let one_sec = Duration::new(1, 0);
565         assert_eq!(one_nano.checked_sub(zero), Some(Duration::new(0, 1)));
566         assert_eq!(one_sec.checked_sub(one_nano),
567                    Some(Duration::new(0, 999_999_999)));
568         assert_eq!(zero.checked_sub(one_nano), None);
569         assert_eq!(zero.checked_sub(one_sec), None);
570     }
571
572     #[test] #[should_panic]
573     fn sub_bad1() {
574         Duration::new(0, 0) - Duration::new(0, 1);
575     }
576
577     #[test] #[should_panic]
578     fn sub_bad2() {
579         Duration::new(0, 0) - Duration::new(1, 0);
580     }
581
582     #[test]
583     fn mul() {
584         assert_eq!(Duration::new(0, 1) * 2, Duration::new(0, 2));
585         assert_eq!(Duration::new(1, 1) * 3, Duration::new(3, 3));
586         assert_eq!(Duration::new(0, 500_000_001) * 4, Duration::new(2, 4));
587         assert_eq!(Duration::new(0, 500_000_001) * 4000,
588                    Duration::new(2000, 4000));
589     }
590
591     #[test]
592     fn checked_mul() {
593         assert_eq!(Duration::new(0, 1).checked_mul(2), Some(Duration::new(0, 2)));
594         assert_eq!(Duration::new(1, 1).checked_mul(3), Some(Duration::new(3, 3)));
595         assert_eq!(Duration::new(0, 500_000_001).checked_mul(4), Some(Duration::new(2, 4)));
596         assert_eq!(Duration::new(0, 500_000_001).checked_mul(4000),
597                    Some(Duration::new(2000, 4000)));
598         assert_eq!(Duration::new(::u64::MAX - 1, 0).checked_mul(2), None);
599     }
600
601     #[test]
602     fn div() {
603         assert_eq!(Duration::new(0, 1) / 2, Duration::new(0, 0));
604         assert_eq!(Duration::new(1, 1) / 3, Duration::new(0, 333_333_333));
605         assert_eq!(Duration::new(99, 999_999_000) / 100,
606                    Duration::new(0, 999_999_990));
607     }
608
609     #[test]
610     fn checked_div() {
611         assert_eq!(Duration::new(2, 0).checked_div(2), Some(Duration::new(1, 0)));
612         assert_eq!(Duration::new(1, 0).checked_div(2), Some(Duration::new(0, 500_000_000)));
613         assert_eq!(Duration::new(2, 0).checked_div(0), None);
614     }
615 }