1 #![stable(feature = "duration_core", since = "1.25.0")]
3 //! Temporal quantification.
7 //! There are multiple ways to create a new [`Duration`]:
10 //! # use std::time::Duration;
11 //! let five_seconds = Duration::from_secs(5);
12 //! assert_eq!(five_seconds, Duration::from_millis(5_000));
13 //! assert_eq!(five_seconds, Duration::from_micros(5_000_000));
14 //! assert_eq!(five_seconds, Duration::from_nanos(5_000_000_000));
16 //! let ten_seconds = Duration::from_secs(10);
17 //! let seven_nanos = Duration::from_nanos(7);
18 //! let total = ten_seconds + seven_nanos;
19 //! assert_eq!(total, Duration::new(10, 7));
24 use crate::ops::{Add, AddAssign, Div, DivAssign, Mul, MulAssign, Sub, SubAssign};
26 const NANOS_PER_SEC: u32 = 1_000_000_000;
27 const NANOS_PER_MILLI: u32 = 1_000_000;
28 const NANOS_PER_MICRO: u32 = 1_000;
29 const MILLIS_PER_SEC: u64 = 1_000;
30 const MICROS_PER_SEC: u64 = 1_000_000;
32 /// A `Duration` type to represent a span of time, typically used for system
35 /// Each `Duration` is composed of a whole number of seconds and a fractional part
36 /// represented in nanoseconds. If the underlying system does not support
37 /// nanosecond-level precision, APIs binding a system timeout will typically round up
38 /// the number of nanoseconds.
40 /// [`Duration`]s implement many common traits, including [`Add`], [`Sub`], and other
41 /// [`ops`] traits. It implements [`Default`] by returning a zero-length `Duration`.
43 /// [`ops`]: crate::ops
48 /// use std::time::Duration;
50 /// let five_seconds = Duration::new(5, 0);
51 /// let five_seconds_and_five_nanos = five_seconds + Duration::new(0, 5);
53 /// assert_eq!(five_seconds_and_five_nanos.as_secs(), 5);
54 /// assert_eq!(five_seconds_and_five_nanos.subsec_nanos(), 5);
56 /// let ten_millis = Duration::from_millis(10);
59 /// # Formatting `Duration` values
61 /// `Duration` intentionally does not have a `Display` impl, as there are a
62 /// variety of ways to format spans of time for human readability. `Duration`
63 /// provides a `Debug` impl that shows the full precision of the value.
65 /// The `Debug` output uses the non-ASCII "µs" suffix for microseconds. If your
66 /// program output may appear in contexts that cannot rely on full Unicode
67 /// compatibility, you may wish to format `Duration` objects yourself or use a
69 #[stable(feature = "duration", since = "1.3.0")]
70 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
71 #[cfg_attr(not(test), rustc_diagnostic_item = "Duration")]
74 nanos: u32, // Always 0 <= nanos < NANOS_PER_SEC
78 /// The duration of one second.
83 /// #![feature(duration_constants)]
84 /// use std::time::Duration;
86 /// assert_eq!(Duration::SECOND, Duration::from_secs(1));
88 #[unstable(feature = "duration_constants", issue = "57391")]
89 pub const SECOND: Duration = Duration::from_secs(1);
91 /// The duration of one millisecond.
96 /// #![feature(duration_constants)]
97 /// use std::time::Duration;
99 /// assert_eq!(Duration::MILLISECOND, Duration::from_millis(1));
101 #[unstable(feature = "duration_constants", issue = "57391")]
102 pub const MILLISECOND: Duration = Duration::from_millis(1);
104 /// The duration of one microsecond.
109 /// #![feature(duration_constants)]
110 /// use std::time::Duration;
112 /// assert_eq!(Duration::MICROSECOND, Duration::from_micros(1));
114 #[unstable(feature = "duration_constants", issue = "57391")]
115 pub const MICROSECOND: Duration = Duration::from_micros(1);
117 /// The duration of one nanosecond.
122 /// #![feature(duration_constants)]
123 /// use std::time::Duration;
125 /// assert_eq!(Duration::NANOSECOND, Duration::from_nanos(1));
127 #[unstable(feature = "duration_constants", issue = "57391")]
128 pub const NANOSECOND: Duration = Duration::from_nanos(1);
130 /// A duration of zero time.
135 /// use std::time::Duration;
137 /// let duration = Duration::ZERO;
138 /// assert!(duration.is_zero());
139 /// assert_eq!(duration.as_nanos(), 0);
141 #[stable(feature = "duration_zero", since = "1.53.0")]
142 pub const ZERO: Duration = Duration::from_nanos(0);
144 /// The maximum duration.
146 /// May vary by platform as necessary. Must be able to contain the difference between
147 /// two instances of [`Instant`] or two instances of [`SystemTime`].
148 /// This constraint gives it a value of about 584,942,417,355 years in practice,
149 /// which is currently used on all platforms.
154 /// use std::time::Duration;
156 /// assert_eq!(Duration::MAX, Duration::new(u64::MAX, 1_000_000_000 - 1));
158 /// [`Instant`]: ../../std/time/struct.Instant.html
159 /// [`SystemTime`]: ../../std/time/struct.SystemTime.html
160 #[stable(feature = "duration_saturating_ops", since = "1.53.0")]
161 pub const MAX: Duration = Duration::new(u64::MAX, NANOS_PER_SEC - 1);
163 /// Creates a new `Duration` from the specified number of whole seconds and
164 /// additional nanoseconds.
166 /// If the number of nanoseconds is greater than 1 billion (the number of
167 /// nanoseconds in a second), then it will carry over into the seconds provided.
171 /// This constructor will panic if the carry from the nanoseconds overflows
172 /// the seconds counter.
177 /// use std::time::Duration;
179 /// let five_seconds = Duration::new(5, 0);
181 #[stable(feature = "duration", since = "1.3.0")]
184 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
185 pub const fn new(secs: u64, nanos: u32) -> Duration {
186 let secs = match secs.checked_add((nanos / NANOS_PER_SEC) as u64) {
188 None => panic!("overflow in Duration::new"),
190 let nanos = nanos % NANOS_PER_SEC;
191 Duration { secs, nanos }
194 /// Creates a new `Duration` from the specified number of whole seconds.
199 /// use std::time::Duration;
201 /// let duration = Duration::from_secs(5);
203 /// assert_eq!(5, duration.as_secs());
204 /// assert_eq!(0, duration.subsec_nanos());
206 #[stable(feature = "duration", since = "1.3.0")]
209 #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
210 pub const fn from_secs(secs: u64) -> Duration {
211 Duration { secs, nanos: 0 }
214 /// Creates a new `Duration` from the specified number of milliseconds.
219 /// use std::time::Duration;
221 /// let duration = Duration::from_millis(2569);
223 /// assert_eq!(2, duration.as_secs());
224 /// assert_eq!(569_000_000, duration.subsec_nanos());
226 #[stable(feature = "duration", since = "1.3.0")]
229 #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
230 pub const fn from_millis(millis: u64) -> Duration {
232 secs: millis / MILLIS_PER_SEC,
233 nanos: ((millis % MILLIS_PER_SEC) as u32) * NANOS_PER_MILLI,
237 /// Creates a new `Duration` from the specified number of microseconds.
242 /// use std::time::Duration;
244 /// let duration = Duration::from_micros(1_000_002);
246 /// assert_eq!(1, duration.as_secs());
247 /// assert_eq!(2000, duration.subsec_nanos());
249 #[stable(feature = "duration_from_micros", since = "1.27.0")]
252 #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
253 pub const fn from_micros(micros: u64) -> Duration {
255 secs: micros / MICROS_PER_SEC,
256 nanos: ((micros % MICROS_PER_SEC) as u32) * NANOS_PER_MICRO,
260 /// Creates a new `Duration` from the specified number of nanoseconds.
265 /// use std::time::Duration;
267 /// let duration = Duration::from_nanos(1_000_000_123);
269 /// assert_eq!(1, duration.as_secs());
270 /// assert_eq!(123, duration.subsec_nanos());
272 #[stable(feature = "duration_extras", since = "1.27.0")]
275 #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
276 pub const fn from_nanos(nanos: u64) -> Duration {
278 secs: nanos / (NANOS_PER_SEC as u64),
279 nanos: (nanos % (NANOS_PER_SEC as u64)) as u32,
283 /// Returns true if this `Duration` spans no time.
288 /// use std::time::Duration;
290 /// assert!(Duration::ZERO.is_zero());
291 /// assert!(Duration::new(0, 0).is_zero());
292 /// assert!(Duration::from_nanos(0).is_zero());
293 /// assert!(Duration::from_secs(0).is_zero());
295 /// assert!(!Duration::new(1, 1).is_zero());
296 /// assert!(!Duration::from_nanos(1).is_zero());
297 /// assert!(!Duration::from_secs(1).is_zero());
300 #[stable(feature = "duration_zero", since = "1.53.0")]
301 #[rustc_const_stable(feature = "duration_zero", since = "1.53.0")]
303 pub const fn is_zero(&self) -> bool {
304 self.secs == 0 && self.nanos == 0
307 /// Returns the number of _whole_ seconds contained by this `Duration`.
309 /// The returned value does not include the fractional (nanosecond) part of the
310 /// duration, which can be obtained using [`subsec_nanos`].
315 /// use std::time::Duration;
317 /// let duration = Duration::new(5, 730023852);
318 /// assert_eq!(duration.as_secs(), 5);
321 /// To determine the total number of seconds represented by the `Duration`,
322 /// use `as_secs` in combination with [`subsec_nanos`]:
325 /// use std::time::Duration;
327 /// let duration = Duration::new(5, 730023852);
329 /// assert_eq!(5.730023852,
330 /// duration.as_secs() as f64
331 /// + duration.subsec_nanos() as f64 * 1e-9);
334 /// [`subsec_nanos`]: Duration::subsec_nanos
335 #[stable(feature = "duration", since = "1.3.0")]
336 #[rustc_const_stable(feature = "duration", since = "1.32.0")]
339 pub const fn as_secs(&self) -> u64 {
343 /// Returns the fractional part of this `Duration`, in whole milliseconds.
345 /// This method does **not** return the length of the duration when
346 /// represented by milliseconds. The returned number always represents a
347 /// fractional portion of a second (i.e., it is less than one thousand).
352 /// use std::time::Duration;
354 /// let duration = Duration::from_millis(5432);
355 /// assert_eq!(duration.as_secs(), 5);
356 /// assert_eq!(duration.subsec_millis(), 432);
358 #[stable(feature = "duration_extras", since = "1.27.0")]
359 #[rustc_const_stable(feature = "duration_extras", since = "1.32.0")]
362 pub const fn subsec_millis(&self) -> u32 {
363 self.nanos / NANOS_PER_MILLI
366 /// Returns the fractional part of this `Duration`, in whole microseconds.
368 /// This method does **not** return the length of the duration when
369 /// represented by microseconds. The returned number always represents a
370 /// fractional portion of a second (i.e., it is less than one million).
375 /// use std::time::Duration;
377 /// let duration = Duration::from_micros(1_234_567);
378 /// assert_eq!(duration.as_secs(), 1);
379 /// assert_eq!(duration.subsec_micros(), 234_567);
381 #[stable(feature = "duration_extras", since = "1.27.0")]
382 #[rustc_const_stable(feature = "duration_extras", since = "1.32.0")]
385 pub const fn subsec_micros(&self) -> u32 {
386 self.nanos / NANOS_PER_MICRO
389 /// Returns the fractional part of this `Duration`, in nanoseconds.
391 /// This method does **not** return the length of the duration when
392 /// represented by nanoseconds. The returned number always represents a
393 /// fractional portion of a second (i.e., it is less than one billion).
398 /// use std::time::Duration;
400 /// let duration = Duration::from_millis(5010);
401 /// assert_eq!(duration.as_secs(), 5);
402 /// assert_eq!(duration.subsec_nanos(), 10_000_000);
404 #[stable(feature = "duration", since = "1.3.0")]
405 #[rustc_const_stable(feature = "duration", since = "1.32.0")]
408 pub const fn subsec_nanos(&self) -> u32 {
412 /// Returns the total number of whole milliseconds contained by this `Duration`.
417 /// use std::time::Duration;
419 /// let duration = Duration::new(5, 730023852);
420 /// assert_eq!(duration.as_millis(), 5730);
422 #[stable(feature = "duration_as_u128", since = "1.33.0")]
423 #[rustc_const_stable(feature = "duration_as_u128", since = "1.33.0")]
426 pub const fn as_millis(&self) -> u128 {
427 self.secs as u128 * MILLIS_PER_SEC as u128 + (self.nanos / NANOS_PER_MILLI) as u128
430 /// Returns the total number of whole microseconds contained by this `Duration`.
435 /// use std::time::Duration;
437 /// let duration = Duration::new(5, 730023852);
438 /// assert_eq!(duration.as_micros(), 5730023);
440 #[stable(feature = "duration_as_u128", since = "1.33.0")]
441 #[rustc_const_stable(feature = "duration_as_u128", since = "1.33.0")]
444 pub const fn as_micros(&self) -> u128 {
445 self.secs as u128 * MICROS_PER_SEC as u128 + (self.nanos / NANOS_PER_MICRO) as u128
448 /// Returns the total number of nanoseconds contained by this `Duration`.
453 /// use std::time::Duration;
455 /// let duration = Duration::new(5, 730023852);
456 /// assert_eq!(duration.as_nanos(), 5730023852);
458 #[stable(feature = "duration_as_u128", since = "1.33.0")]
459 #[rustc_const_stable(feature = "duration_as_u128", since = "1.33.0")]
462 pub const fn as_nanos(&self) -> u128 {
463 self.secs as u128 * NANOS_PER_SEC as u128 + self.nanos as u128
466 /// Checked `Duration` addition. Computes `self + other`, returning [`None`]
467 /// if overflow occurred.
474 /// use std::time::Duration;
476 /// assert_eq!(Duration::new(0, 0).checked_add(Duration::new(0, 1)), Some(Duration::new(0, 1)));
477 /// assert_eq!(Duration::new(1, 0).checked_add(Duration::new(u64::MAX, 0)), None);
479 #[stable(feature = "duration_checked_ops", since = "1.16.0")]
480 #[must_use = "this returns the result of the operation, \
481 without modifying the original"]
483 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
484 pub const fn checked_add(self, rhs: Duration) -> Option<Duration> {
485 if let Some(mut secs) = self.secs.checked_add(rhs.secs) {
486 let mut nanos = self.nanos + rhs.nanos;
487 if nanos >= NANOS_PER_SEC {
488 nanos -= NANOS_PER_SEC;
489 if let Some(new_secs) = secs.checked_add(1) {
495 debug_assert!(nanos < NANOS_PER_SEC);
496 Some(Duration { secs, nanos })
502 /// Saturating `Duration` addition. Computes `self + other`, returning [`Duration::MAX`]
503 /// if overflow occurred.
508 /// #![feature(duration_constants)]
509 /// use std::time::Duration;
511 /// assert_eq!(Duration::new(0, 0).saturating_add(Duration::new(0, 1)), Duration::new(0, 1));
512 /// assert_eq!(Duration::new(1, 0).saturating_add(Duration::new(u64::MAX, 0)), Duration::MAX);
514 #[stable(feature = "duration_saturating_ops", since = "1.53.0")]
515 #[must_use = "this returns the result of the operation, \
516 without modifying the original"]
518 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
519 pub const fn saturating_add(self, rhs: Duration) -> Duration {
520 match self.checked_add(rhs) {
522 None => Duration::MAX,
526 /// Checked `Duration` subtraction. Computes `self - other`, returning [`None`]
527 /// if the result would be negative or if overflow occurred.
534 /// use std::time::Duration;
536 /// assert_eq!(Duration::new(0, 1).checked_sub(Duration::new(0, 0)), Some(Duration::new(0, 1)));
537 /// assert_eq!(Duration::new(0, 0).checked_sub(Duration::new(0, 1)), None);
539 #[stable(feature = "duration_checked_ops", since = "1.16.0")]
540 #[must_use = "this returns the result of the operation, \
541 without modifying the original"]
543 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
544 pub const fn checked_sub(self, rhs: Duration) -> Option<Duration> {
545 if let Some(mut secs) = self.secs.checked_sub(rhs.secs) {
546 let nanos = if self.nanos >= rhs.nanos {
547 self.nanos - rhs.nanos
548 } else if let Some(sub_secs) = secs.checked_sub(1) {
550 self.nanos + NANOS_PER_SEC - rhs.nanos
554 debug_assert!(nanos < NANOS_PER_SEC);
555 Some(Duration { secs, nanos })
561 /// Saturating `Duration` subtraction. Computes `self - other`, returning [`Duration::ZERO`]
562 /// if the result would be negative or if overflow occurred.
567 /// use std::time::Duration;
569 /// assert_eq!(Duration::new(0, 1).saturating_sub(Duration::new(0, 0)), Duration::new(0, 1));
570 /// assert_eq!(Duration::new(0, 0).saturating_sub(Duration::new(0, 1)), Duration::ZERO);
572 #[stable(feature = "duration_saturating_ops", since = "1.53.0")]
573 #[must_use = "this returns the result of the operation, \
574 without modifying the original"]
576 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
577 pub const fn saturating_sub(self, rhs: Duration) -> Duration {
578 match self.checked_sub(rhs) {
580 None => Duration::ZERO,
584 /// Checked `Duration` multiplication. Computes `self * other`, returning
585 /// [`None`] if overflow occurred.
592 /// use std::time::Duration;
594 /// assert_eq!(Duration::new(0, 500_000_001).checked_mul(2), Some(Duration::new(1, 2)));
595 /// assert_eq!(Duration::new(u64::MAX - 1, 0).checked_mul(2), None);
597 #[stable(feature = "duration_checked_ops", since = "1.16.0")]
598 #[must_use = "this returns the result of the operation, \
599 without modifying the original"]
601 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
602 pub const fn checked_mul(self, rhs: u32) -> Option<Duration> {
603 // Multiply nanoseconds as u64, because it cannot overflow that way.
604 let total_nanos = self.nanos as u64 * rhs as u64;
605 let extra_secs = total_nanos / (NANOS_PER_SEC as u64);
606 let nanos = (total_nanos % (NANOS_PER_SEC as u64)) as u32;
607 if let Some(s) = self.secs.checked_mul(rhs as u64) {
608 if let Some(secs) = s.checked_add(extra_secs) {
609 debug_assert!(nanos < NANOS_PER_SEC);
610 return Some(Duration { secs, nanos });
616 /// Saturating `Duration` multiplication. Computes `self * other`, returning
617 /// [`Duration::MAX`] if overflow occurred.
622 /// #![feature(duration_constants)]
623 /// use std::time::Duration;
625 /// assert_eq!(Duration::new(0, 500_000_001).saturating_mul(2), Duration::new(1, 2));
626 /// assert_eq!(Duration::new(u64::MAX - 1, 0).saturating_mul(2), Duration::MAX);
628 #[stable(feature = "duration_saturating_ops", since = "1.53.0")]
629 #[must_use = "this returns the result of the operation, \
630 without modifying the original"]
632 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
633 pub const fn saturating_mul(self, rhs: u32) -> Duration {
634 match self.checked_mul(rhs) {
636 None => Duration::MAX,
640 /// Checked `Duration` division. Computes `self / other`, returning [`None`]
648 /// use std::time::Duration;
650 /// assert_eq!(Duration::new(2, 0).checked_div(2), Some(Duration::new(1, 0)));
651 /// assert_eq!(Duration::new(1, 0).checked_div(2), Some(Duration::new(0, 500_000_000)));
652 /// assert_eq!(Duration::new(2, 0).checked_div(0), None);
654 #[stable(feature = "duration_checked_ops", since = "1.16.0")]
655 #[must_use = "this returns the result of the operation, \
656 without modifying the original"]
658 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
659 pub const fn checked_div(self, rhs: u32) -> Option<Duration> {
661 let secs = self.secs / (rhs as u64);
662 let carry = self.secs - secs * (rhs as u64);
663 let extra_nanos = carry * (NANOS_PER_SEC as u64) / (rhs as u64);
664 let nanos = self.nanos / rhs + (extra_nanos as u32);
665 debug_assert!(nanos < NANOS_PER_SEC);
666 Some(Duration { secs, nanos })
672 /// Returns the number of seconds contained by this `Duration` as `f64`.
674 /// The returned value does include the fractional (nanosecond) part of the duration.
678 /// use std::time::Duration;
680 /// let dur = Duration::new(2, 700_000_000);
681 /// assert_eq!(dur.as_secs_f64(), 2.7);
683 #[stable(feature = "duration_float", since = "1.38.0")]
686 #[rustc_const_unstable(feature = "duration_consts_float", issue = "72440")]
687 pub const fn as_secs_f64(&self) -> f64 {
688 (self.secs as f64) + (self.nanos as f64) / (NANOS_PER_SEC as f64)
691 /// Returns the number of seconds contained by this `Duration` as `f32`.
693 /// The returned value does include the fractional (nanosecond) part of the duration.
697 /// use std::time::Duration;
699 /// let dur = Duration::new(2, 700_000_000);
700 /// assert_eq!(dur.as_secs_f32(), 2.7);
702 #[stable(feature = "duration_float", since = "1.38.0")]
705 #[rustc_const_unstable(feature = "duration_consts_float", issue = "72440")]
706 pub const fn as_secs_f32(&self) -> f32 {
707 (self.secs as f32) + (self.nanos as f32) / (NANOS_PER_SEC as f32)
710 /// Creates a new `Duration` from the specified number of seconds represented
714 /// This constructor will panic if `secs` is not finite, negative or overflows `Duration`.
718 /// use std::time::Duration;
720 /// let dur = Duration::from_secs_f64(2.7);
721 /// assert_eq!(dur, Duration::new(2, 700_000_000));
723 #[stable(feature = "duration_float", since = "1.38.0")]
726 #[rustc_const_unstable(feature = "duration_consts_float", issue = "72440")]
727 pub const fn from_secs_f64(secs: f64) -> Duration {
728 match Duration::try_from_secs_f64(secs) {
730 Err(e) => panic!("{}", e.description()),
734 /// The checked version of [`from_secs_f64`].
736 /// [`from_secs_f64`]: Duration::from_secs_f64
738 /// This constructor will return an `Err` if `secs` is not finite, negative or overflows `Duration`.
742 /// #![feature(duration_checked_float)]
743 /// use std::time::Duration;
745 /// let dur = Duration::try_from_secs_f64(2.7);
746 /// assert_eq!(dur, Ok(Duration::new(2, 700_000_000)));
748 /// let negative = Duration::try_from_secs_f64(-5.0);
749 /// assert!(negative.is_err());
751 #[unstable(feature = "duration_checked_float", issue = "83400")]
753 pub const fn try_from_secs_f64(secs: f64) -> Result<Duration, FromSecsError> {
754 const MAX_NANOS_F64: f64 = ((u64::MAX as u128 + 1) * (NANOS_PER_SEC as u128)) as f64;
755 let nanos = secs * (NANOS_PER_SEC as f64);
756 if !nanos.is_finite() {
757 Err(FromSecsError { kind: FromSecsErrorKind::NonFinite })
758 } else if nanos >= MAX_NANOS_F64 {
759 Err(FromSecsError { kind: FromSecsErrorKind::Overflow })
760 } else if nanos < 0.0 {
761 Err(FromSecsError { kind: FromSecsErrorKind::Negative })
763 let nanos = nanos as u128;
765 secs: (nanos / (NANOS_PER_SEC as u128)) as u64,
766 nanos: (nanos % (NANOS_PER_SEC as u128)) as u32,
771 /// Creates a new `Duration` from the specified number of seconds represented
775 /// This constructor will panic if `secs` is not finite, negative or overflows `Duration`.
779 /// use std::time::Duration;
781 /// let dur = Duration::from_secs_f32(2.7);
782 /// assert_eq!(dur, Duration::new(2, 700_000_000));
784 #[stable(feature = "duration_float", since = "1.38.0")]
787 #[rustc_const_unstable(feature = "duration_consts_float", issue = "72440")]
788 pub const fn from_secs_f32(secs: f32) -> Duration {
789 match Duration::try_from_secs_f32(secs) {
791 Err(e) => panic!("{}", e.description()),
795 /// The checked version of [`from_secs_f32`].
797 /// [`from_secs_f32`]: Duration::from_secs_f32
799 /// This constructor will return an `Err` if `secs` is not finite, negative or overflows `Duration`.
803 /// #![feature(duration_checked_float)]
804 /// use std::time::Duration;
806 /// let dur = Duration::try_from_secs_f32(2.7);
807 /// assert_eq!(dur, Ok(Duration::new(2, 700_000_000)));
809 /// let negative = Duration::try_from_secs_f32(-5.0);
810 /// assert!(negative.is_err());
812 #[unstable(feature = "duration_checked_float", issue = "83400")]
814 pub const fn try_from_secs_f32(secs: f32) -> Result<Duration, FromSecsError> {
815 const MAX_NANOS_F32: f32 = ((u64::MAX as u128 + 1) * (NANOS_PER_SEC as u128)) as f32;
816 let nanos = secs * (NANOS_PER_SEC as f32);
817 if !nanos.is_finite() {
818 Err(FromSecsError { kind: FromSecsErrorKind::NonFinite })
819 } else if nanos >= MAX_NANOS_F32 {
820 Err(FromSecsError { kind: FromSecsErrorKind::Overflow })
821 } else if nanos < 0.0 {
822 Err(FromSecsError { kind: FromSecsErrorKind::Negative })
824 let nanos = nanos as u128;
826 secs: (nanos / (NANOS_PER_SEC as u128)) as u64,
827 nanos: (nanos % (NANOS_PER_SEC as u128)) as u32,
832 /// Multiplies `Duration` by `f64`.
835 /// This method will panic if result is not finite, negative or overflows `Duration`.
839 /// use std::time::Duration;
841 /// let dur = Duration::new(2, 700_000_000);
842 /// assert_eq!(dur.mul_f64(3.14), Duration::new(8, 478_000_000));
843 /// assert_eq!(dur.mul_f64(3.14e5), Duration::new(847_800, 0));
845 #[stable(feature = "duration_float", since = "1.38.0")]
846 #[must_use = "this returns the result of the operation, \
847 without modifying the original"]
849 #[rustc_const_unstable(feature = "duration_consts_float", issue = "72440")]
850 pub const fn mul_f64(self, rhs: f64) -> Duration {
851 Duration::from_secs_f64(rhs * self.as_secs_f64())
854 /// Multiplies `Duration` by `f32`.
857 /// This method will panic if result is not finite, negative or overflows `Duration`.
861 /// use std::time::Duration;
863 /// let dur = Duration::new(2, 700_000_000);
864 /// // note that due to rounding errors result is slightly different
865 /// // from 8.478 and 847800.0
866 /// assert_eq!(dur.mul_f32(3.14), Duration::new(8, 478_000_640));
867 /// assert_eq!(dur.mul_f32(3.14e5), Duration::new(847799, 969_120_256));
869 #[stable(feature = "duration_float", since = "1.38.0")]
870 #[must_use = "this returns the result of the operation, \
871 without modifying the original"]
873 #[rustc_const_unstable(feature = "duration_consts_float", issue = "72440")]
874 pub const fn mul_f32(self, rhs: f32) -> Duration {
875 Duration::from_secs_f32(rhs * self.as_secs_f32())
878 /// Divide `Duration` by `f64`.
881 /// This method will panic if result is not finite, negative or overflows `Duration`.
885 /// use std::time::Duration;
887 /// let dur = Duration::new(2, 700_000_000);
888 /// assert_eq!(dur.div_f64(3.14), Duration::new(0, 859_872_611));
889 /// // note that truncation is used, not rounding
890 /// assert_eq!(dur.div_f64(3.14e5), Duration::new(0, 8_598));
892 #[stable(feature = "duration_float", since = "1.38.0")]
893 #[must_use = "this returns the result of the operation, \
894 without modifying the original"]
896 #[rustc_const_unstable(feature = "duration_consts_float", issue = "72440")]
897 pub const fn div_f64(self, rhs: f64) -> Duration {
898 Duration::from_secs_f64(self.as_secs_f64() / rhs)
901 /// Divide `Duration` by `f32`.
904 /// This method will panic if result is not finite, negative or overflows `Duration`.
908 /// use std::time::Duration;
910 /// let dur = Duration::new(2, 700_000_000);
911 /// // note that due to rounding errors result is slightly
912 /// // different from 0.859_872_611
913 /// assert_eq!(dur.div_f32(3.14), Duration::new(0, 859_872_576));
914 /// // note that truncation is used, not rounding
915 /// assert_eq!(dur.div_f32(3.14e5), Duration::new(0, 8_598));
917 #[stable(feature = "duration_float", since = "1.38.0")]
918 #[must_use = "this returns the result of the operation, \
919 without modifying the original"]
921 #[rustc_const_unstable(feature = "duration_consts_float", issue = "72440")]
922 pub const fn div_f32(self, rhs: f32) -> Duration {
923 Duration::from_secs_f32(self.as_secs_f32() / rhs)
926 /// Divide `Duration` by `Duration` and return `f64`.
930 /// #![feature(div_duration)]
931 /// use std::time::Duration;
933 /// let dur1 = Duration::new(2, 700_000_000);
934 /// let dur2 = Duration::new(5, 400_000_000);
935 /// assert_eq!(dur1.div_duration_f64(dur2), 0.5);
937 #[unstable(feature = "div_duration", issue = "63139")]
938 #[must_use = "this returns the result of the operation, \
939 without modifying the original"]
941 #[rustc_const_unstable(feature = "duration_consts_float", issue = "72440")]
942 pub const fn div_duration_f64(self, rhs: Duration) -> f64 {
943 self.as_secs_f64() / rhs.as_secs_f64()
946 /// Divide `Duration` by `Duration` and return `f32`.
950 /// #![feature(div_duration)]
951 /// use std::time::Duration;
953 /// let dur1 = Duration::new(2, 700_000_000);
954 /// let dur2 = Duration::new(5, 400_000_000);
955 /// assert_eq!(dur1.div_duration_f32(dur2), 0.5);
957 #[unstable(feature = "div_duration", issue = "63139")]
958 #[must_use = "this returns the result of the operation, \
959 without modifying the original"]
961 #[rustc_const_unstable(feature = "duration_consts_float", issue = "72440")]
962 pub const fn div_duration_f32(self, rhs: Duration) -> f32 {
963 self.as_secs_f32() / rhs.as_secs_f32()
967 #[stable(feature = "duration", since = "1.3.0")]
968 impl Add for Duration {
969 type Output = Duration;
971 fn add(self, rhs: Duration) -> Duration {
972 self.checked_add(rhs).expect("overflow when adding durations")
976 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
977 impl AddAssign for Duration {
978 fn add_assign(&mut self, rhs: Duration) {
983 #[stable(feature = "duration", since = "1.3.0")]
984 impl Sub for Duration {
985 type Output = Duration;
987 fn sub(self, rhs: Duration) -> Duration {
988 self.checked_sub(rhs).expect("overflow when subtracting durations")
992 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
993 impl SubAssign for Duration {
994 fn sub_assign(&mut self, rhs: Duration) {
999 #[stable(feature = "duration", since = "1.3.0")]
1000 impl Mul<u32> for Duration {
1001 type Output = Duration;
1003 fn mul(self, rhs: u32) -> Duration {
1004 self.checked_mul(rhs).expect("overflow when multiplying duration by scalar")
1008 #[stable(feature = "symmetric_u32_duration_mul", since = "1.31.0")]
1009 impl Mul<Duration> for u32 {
1010 type Output = Duration;
1012 fn mul(self, rhs: Duration) -> Duration {
1017 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
1018 impl MulAssign<u32> for Duration {
1019 fn mul_assign(&mut self, rhs: u32) {
1020 *self = *self * rhs;
1024 #[stable(feature = "duration", since = "1.3.0")]
1025 impl Div<u32> for Duration {
1026 type Output = Duration;
1028 fn div(self, rhs: u32) -> Duration {
1029 self.checked_div(rhs).expect("divide by zero error when dividing duration by scalar")
1033 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
1034 impl DivAssign<u32> for Duration {
1035 fn div_assign(&mut self, rhs: u32) {
1036 *self = *self / rhs;
1040 macro_rules! sum_durations {
1042 let mut total_secs: u64 = 0;
1043 let mut total_nanos: u64 = 0;
1045 for entry in $iter {
1047 total_secs.checked_add(entry.secs).expect("overflow in iter::sum over durations");
1048 total_nanos = match total_nanos.checked_add(entry.nanos as u64) {
1051 total_secs = total_secs
1052 .checked_add(total_nanos / NANOS_PER_SEC as u64)
1053 .expect("overflow in iter::sum over durations");
1054 (total_nanos % NANOS_PER_SEC as u64) + entry.nanos as u64
1058 total_secs = total_secs
1059 .checked_add(total_nanos / NANOS_PER_SEC as u64)
1060 .expect("overflow in iter::sum over durations");
1061 total_nanos = total_nanos % NANOS_PER_SEC as u64;
1062 Duration { secs: total_secs, nanos: total_nanos as u32 }
1066 #[stable(feature = "duration_sum", since = "1.16.0")]
1067 impl Sum for Duration {
1068 fn sum<I: Iterator<Item = Duration>>(iter: I) -> Duration {
1069 sum_durations!(iter)
1073 #[stable(feature = "duration_sum", since = "1.16.0")]
1074 impl<'a> Sum<&'a Duration> for Duration {
1075 fn sum<I: Iterator<Item = &'a Duration>>(iter: I) -> Duration {
1076 sum_durations!(iter)
1080 #[stable(feature = "duration_debug_impl", since = "1.27.0")]
1081 impl fmt::Debug for Duration {
1082 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1083 /// Formats a floating point number in decimal notation.
1085 /// The number is given as the `integer_part` and a fractional part.
1086 /// The value of the fractional part is `fractional_part / divisor`. So
1087 /// `integer_part` = 3, `fractional_part` = 12 and `divisor` = 100
1088 /// represents the number `3.012`. Trailing zeros are omitted.
1090 /// `divisor` must not be above 100_000_000. It also should be a power
1091 /// of 10, everything else doesn't make sense. `fractional_part` has
1092 /// to be less than `10 * divisor`!
1094 /// A prefix and postfix may be added. The whole thing is padded
1095 /// to the formatter's `width`, if specified.
1097 f: &mut fmt::Formatter<'_>,
1098 mut integer_part: u64,
1099 mut fractional_part: u32,
1104 // Encode the fractional part into a temporary buffer. The buffer
1105 // only need to hold 9 elements, because `fractional_part` has to
1106 // be smaller than 10^9. The buffer is prefilled with '0' digits
1107 // to simplify the code below.
1108 let mut buf = [b'0'; 9];
1110 // The next digit is written at this position
1113 // We keep writing digits into the buffer while there are non-zero
1114 // digits left and we haven't written enough digits yet.
1115 while fractional_part > 0 && pos < f.precision().unwrap_or(9) {
1116 // Write new digit into the buffer
1117 buf[pos] = b'0' + (fractional_part / divisor) as u8;
1119 fractional_part %= divisor;
1124 // If a precision < 9 was specified, there may be some non-zero
1125 // digits left that weren't written into the buffer. In that case we
1126 // need to perform rounding to match the semantics of printing
1127 // normal floating point numbers. However, we only need to do work
1128 // when rounding up. This happens if the first digit of the
1129 // remaining ones is >= 5.
1130 if fractional_part > 0 && fractional_part >= divisor * 5 {
1131 // Round up the number contained in the buffer. We go through
1132 // the buffer backwards and keep track of the carry.
1133 let mut rev_pos = pos;
1134 let mut carry = true;
1135 while carry && rev_pos > 0 {
1138 // If the digit in the buffer is not '9', we just need to
1139 // increment it and can stop then (since we don't have a
1140 // carry anymore). Otherwise, we set it to '0' (overflow)
1142 if buf[rev_pos] < b'9' {
1146 buf[rev_pos] = b'0';
1150 // If we still have the carry bit set, that means that we set
1151 // the whole buffer to '0's and need to increment the integer
1158 // Determine the end of the buffer: if precision is set, we just
1159 // use as many digits from the buffer (capped to 9). If it isn't
1160 // set, we only use all digits up to the last non-zero one.
1161 let end = f.precision().map(|p| crate::cmp::min(p, 9)).unwrap_or(pos);
1163 // This closure emits the formatted duration without emitting any
1164 // padding (padding is calculated below).
1165 let emit_without_padding = |f: &mut fmt::Formatter<'_>| {
1166 write!(f, "{}{}", prefix, integer_part)?;
1168 // Write the decimal point and the fractional part (if any).
1170 // SAFETY: We are only writing ASCII digits into the buffer and
1171 // it was initialized with '0's, so it contains valid UTF8.
1172 let s = unsafe { crate::str::from_utf8_unchecked(&buf[..end]) };
1174 // If the user request a precision > 9, we pad '0's at the end.
1175 let w = f.precision().unwrap_or(pos);
1176 write!(f, ".{:0<width$}", s, width = w)?;
1179 write!(f, "{}", postfix)
1184 // No `width` specified. There's no need to calculate the
1185 // length of the output in this case, just emit it.
1186 emit_without_padding(f)
1188 Some(requested_w) => {
1189 // A `width` was specified. Calculate the actual width of
1190 // the output in order to calculate the required padding.
1191 // It consists of 4 parts:
1192 // 1. The prefix: is either "+" or "", so we can just use len().
1193 // 2. The postfix: can be "µs" so we have to count UTF8 characters.
1194 let mut actual_w = prefix.len() + postfix.chars().count();
1195 // 3. The integer part:
1196 if let Some(log) = integer_part.checked_log10() {
1197 // integer_part is > 0, so has length log10(x)+1
1198 actual_w += 1 + log as usize;
1200 // integer_part is 0, so has length 1.
1203 // 4. The fractional part (if any):
1205 let frac_part_w = f.precision().unwrap_or(pos);
1206 actual_w += 1 + frac_part_w;
1209 if requested_w <= actual_w {
1210 // Output is already longer than `width`, so don't pad.
1211 emit_without_padding(f)
1213 // We need to add padding. Use the `Formatter::padding` helper function.
1214 let default_align = crate::fmt::rt::v1::Alignment::Left;
1215 let post_padding = f.padding(requested_w - actual_w, default_align)?;
1216 emit_without_padding(f)?;
1217 post_padding.write(f)
1223 // Print leading '+' sign if requested
1224 let prefix = if f.sign_plus() { "+" } else { "" };
1227 fmt_decimal(f, self.secs, self.nanos, NANOS_PER_SEC / 10, prefix, "s")
1228 } else if self.nanos >= NANOS_PER_MILLI {
1231 (self.nanos / NANOS_PER_MILLI) as u64,
1232 self.nanos % NANOS_PER_MILLI,
1233 NANOS_PER_MILLI / 10,
1237 } else if self.nanos >= NANOS_PER_MICRO {
1240 (self.nanos / NANOS_PER_MICRO) as u64,
1241 self.nanos % NANOS_PER_MICRO,
1242 NANOS_PER_MICRO / 10,
1247 fmt_decimal(f, self.nanos as u64, 0, 1, prefix, "ns")
1252 /// An error which can be returned when converting a floating-point value of seconds
1253 /// into a [`Duration`].
1255 /// This error is used as the error type for [`Duration::try_from_secs_f32`] and
1256 /// [`Duration::try_from_secs_f64`].
1261 /// #![feature(duration_checked_float)]
1262 /// use std::time::Duration;
1264 /// if let Err(e) = Duration::try_from_secs_f32(-1.0) {
1265 /// println!("Failed conversion to Duration: {}", e);
1268 #[derive(Debug, Clone, PartialEq, Eq)]
1269 #[unstable(feature = "duration_checked_float", issue = "83400")]
1270 pub struct FromSecsError {
1271 kind: FromSecsErrorKind,
1274 impl FromSecsError {
1275 const fn description(&self) -> &'static str {
1277 FromSecsErrorKind::NonFinite => "non-finite value when converting float to duration",
1278 FromSecsErrorKind::Overflow => "overflow when converting float to duration",
1279 FromSecsErrorKind::Negative => "negative value when converting float to duration",
1284 #[unstable(feature = "duration_checked_float", issue = "83400")]
1285 impl fmt::Display for FromSecsError {
1286 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1287 fmt::Display::fmt(self.description(), f)
1291 #[derive(Debug, Clone, PartialEq, Eq)]
1292 enum FromSecsErrorKind {
1293 // Value is not a finite value (either + or - infinity or NaN).
1295 // Value is too large to store in a `Duration`.
1297 // Value is negative.