]> git.lizzy.rs Git - rust.git/blob - library/core/src/time.rs
Fix two false positive lints
[rust.git] / library / core / src / time.rs
1 #![stable(feature = "duration_core", since = "1.25.0")]
2
3 //! Temporal quantification.
4 //!
5 //! # Examples:
6 //!
7 //! There are multiple ways to create a new [`Duration`]:
8 //!
9 //! ```
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));
15 //!
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));
20 //! ```
21
22 use crate::fmt;
23 use crate::iter::Sum;
24 use crate::ops::{Add, AddAssign, Div, DivAssign, Mul, MulAssign, Sub, SubAssign};
25
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;
31
32 /// A `Duration` type to represent a span of time, typically used for system
33 /// timeouts.
34 ///
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.
39 ///
40 /// [`Duration`]s implement many common traits, including [`Add`], [`Sub`], and other
41 /// [`ops`] traits. It implements [`Default`] by returning a zero-length `Duration`.
42 ///
43 /// [`ops`]: crate::ops
44 ///
45 /// # Examples
46 ///
47 /// ```
48 /// use std::time::Duration;
49 ///
50 /// let five_seconds = Duration::new(5, 0);
51 /// let five_seconds_and_five_nanos = five_seconds + Duration::new(0, 5);
52 ///
53 /// assert_eq!(five_seconds_and_five_nanos.as_secs(), 5);
54 /// assert_eq!(five_seconds_and_five_nanos.subsec_nanos(), 5);
55 ///
56 /// let ten_millis = Duration::from_millis(10);
57 /// ```
58 ///
59 /// # Formatting `Duration` values
60 ///
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.
64 ///
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
68 /// crate to do so.
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")]
72 pub struct Duration {
73     secs: u64,
74     nanos: u32, // Always 0 <= nanos < NANOS_PER_SEC
75 }
76
77 impl Duration {
78     /// The duration of one second.
79     ///
80     /// # Examples
81     ///
82     /// ```
83     /// #![feature(duration_constants)]
84     /// use std::time::Duration;
85     ///
86     /// assert_eq!(Duration::SECOND, Duration::from_secs(1));
87     /// ```
88     #[unstable(feature = "duration_constants", issue = "57391")]
89     pub const SECOND: Duration = Duration::from_secs(1);
90
91     /// The duration of one millisecond.
92     ///
93     /// # Examples
94     ///
95     /// ```
96     /// #![feature(duration_constants)]
97     /// use std::time::Duration;
98     ///
99     /// assert_eq!(Duration::MILLISECOND, Duration::from_millis(1));
100     /// ```
101     #[unstable(feature = "duration_constants", issue = "57391")]
102     pub const MILLISECOND: Duration = Duration::from_millis(1);
103
104     /// The duration of one microsecond.
105     ///
106     /// # Examples
107     ///
108     /// ```
109     /// #![feature(duration_constants)]
110     /// use std::time::Duration;
111     ///
112     /// assert_eq!(Duration::MICROSECOND, Duration::from_micros(1));
113     /// ```
114     #[unstable(feature = "duration_constants", issue = "57391")]
115     pub const MICROSECOND: Duration = Duration::from_micros(1);
116
117     /// The duration of one nanosecond.
118     ///
119     /// # Examples
120     ///
121     /// ```
122     /// #![feature(duration_constants)]
123     /// use std::time::Duration;
124     ///
125     /// assert_eq!(Duration::NANOSECOND, Duration::from_nanos(1));
126     /// ```
127     #[unstable(feature = "duration_constants", issue = "57391")]
128     pub const NANOSECOND: Duration = Duration::from_nanos(1);
129
130     /// A duration of zero time.
131     ///
132     /// # Examples
133     ///
134     /// ```
135     /// use std::time::Duration;
136     ///
137     /// let duration = Duration::ZERO;
138     /// assert!(duration.is_zero());
139     /// assert_eq!(duration.as_nanos(), 0);
140     /// ```
141     #[stable(feature = "duration_zero", since = "1.53.0")]
142     pub const ZERO: Duration = Duration::from_nanos(0);
143
144     /// The maximum duration.
145     ///
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.
150     ///
151     /// # Examples
152     ///
153     /// ```
154     /// use std::time::Duration;
155     ///
156     /// assert_eq!(Duration::MAX, Duration::new(u64::MAX, 1_000_000_000 - 1));
157     /// ```
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);
162
163     /// Creates a new `Duration` from the specified number of whole seconds and
164     /// additional nanoseconds.
165     ///
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.
168     ///
169     /// # Panics
170     ///
171     /// This constructor will panic if the carry from the nanoseconds overflows
172     /// the seconds counter.
173     ///
174     /// # Examples
175     ///
176     /// ```
177     /// use std::time::Duration;
178     ///
179     /// let five_seconds = Duration::new(5, 0);
180     /// ```
181     #[stable(feature = "duration", since = "1.3.0")]
182     #[inline]
183     #[must_use]
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) {
187             Some(secs) => secs,
188             None => panic!("overflow in Duration::new"),
189         };
190         let nanos = nanos % NANOS_PER_SEC;
191         Duration { secs, nanos }
192     }
193
194     /// Creates a new `Duration` from the specified number of whole seconds.
195     ///
196     /// # Examples
197     ///
198     /// ```
199     /// use std::time::Duration;
200     ///
201     /// let duration = Duration::from_secs(5);
202     ///
203     /// assert_eq!(5, duration.as_secs());
204     /// assert_eq!(0, duration.subsec_nanos());
205     /// ```
206     #[stable(feature = "duration", since = "1.3.0")]
207     #[must_use]
208     #[inline]
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 }
212     }
213
214     /// Creates a new `Duration` from the specified number of milliseconds.
215     ///
216     /// # Examples
217     ///
218     /// ```
219     /// use std::time::Duration;
220     ///
221     /// let duration = Duration::from_millis(2569);
222     ///
223     /// assert_eq!(2, duration.as_secs());
224     /// assert_eq!(569_000_000, duration.subsec_nanos());
225     /// ```
226     #[stable(feature = "duration", since = "1.3.0")]
227     #[must_use]
228     #[inline]
229     #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
230     pub const fn from_millis(millis: u64) -> Duration {
231         Duration {
232             secs: millis / MILLIS_PER_SEC,
233             nanos: ((millis % MILLIS_PER_SEC) as u32) * NANOS_PER_MILLI,
234         }
235     }
236
237     /// Creates a new `Duration` from the specified number of microseconds.
238     ///
239     /// # Examples
240     ///
241     /// ```
242     /// use std::time::Duration;
243     ///
244     /// let duration = Duration::from_micros(1_000_002);
245     ///
246     /// assert_eq!(1, duration.as_secs());
247     /// assert_eq!(2000, duration.subsec_nanos());
248     /// ```
249     #[stable(feature = "duration_from_micros", since = "1.27.0")]
250     #[must_use]
251     #[inline]
252     #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
253     pub const fn from_micros(micros: u64) -> Duration {
254         Duration {
255             secs: micros / MICROS_PER_SEC,
256             nanos: ((micros % MICROS_PER_SEC) as u32) * NANOS_PER_MICRO,
257         }
258     }
259
260     /// Creates a new `Duration` from the specified number of nanoseconds.
261     ///
262     /// # Examples
263     ///
264     /// ```
265     /// use std::time::Duration;
266     ///
267     /// let duration = Duration::from_nanos(1_000_000_123);
268     ///
269     /// assert_eq!(1, duration.as_secs());
270     /// assert_eq!(123, duration.subsec_nanos());
271     /// ```
272     #[stable(feature = "duration_extras", since = "1.27.0")]
273     #[must_use]
274     #[inline]
275     #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
276     pub const fn from_nanos(nanos: u64) -> Duration {
277         Duration {
278             secs: nanos / (NANOS_PER_SEC as u64),
279             nanos: (nanos % (NANOS_PER_SEC as u64)) as u32,
280         }
281     }
282
283     /// Returns true if this `Duration` spans no time.
284     ///
285     /// # Examples
286     ///
287     /// ```
288     /// use std::time::Duration;
289     ///
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());
294     ///
295     /// assert!(!Duration::new(1, 1).is_zero());
296     /// assert!(!Duration::from_nanos(1).is_zero());
297     /// assert!(!Duration::from_secs(1).is_zero());
298     /// ```
299     #[must_use]
300     #[stable(feature = "duration_zero", since = "1.53.0")]
301     #[rustc_const_stable(feature = "duration_zero", since = "1.53.0")]
302     #[inline]
303     pub const fn is_zero(&self) -> bool {
304         self.secs == 0 && self.nanos == 0
305     }
306
307     /// Returns the number of _whole_ seconds contained by this `Duration`.
308     ///
309     /// The returned value does not include the fractional (nanosecond) part of the
310     /// duration, which can be obtained using [`subsec_nanos`].
311     ///
312     /// # Examples
313     ///
314     /// ```
315     /// use std::time::Duration;
316     ///
317     /// let duration = Duration::new(5, 730023852);
318     /// assert_eq!(duration.as_secs(), 5);
319     /// ```
320     ///
321     /// To determine the total number of seconds represented by the `Duration`,
322     /// use `as_secs` in combination with [`subsec_nanos`]:
323     ///
324     /// ```
325     /// use std::time::Duration;
326     ///
327     /// let duration = Duration::new(5, 730023852);
328     ///
329     /// assert_eq!(5.730023852,
330     ///            duration.as_secs() as f64
331     ///            + duration.subsec_nanos() as f64 * 1e-9);
332     /// ```
333     ///
334     /// [`subsec_nanos`]: Duration::subsec_nanos
335     #[stable(feature = "duration", since = "1.3.0")]
336     #[rustc_const_stable(feature = "duration", since = "1.32.0")]
337     #[must_use]
338     #[inline]
339     pub const fn as_secs(&self) -> u64 {
340         self.secs
341     }
342
343     /// Returns the fractional part of this `Duration`, in whole milliseconds.
344     ///
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).
348     ///
349     /// # Examples
350     ///
351     /// ```
352     /// use std::time::Duration;
353     ///
354     /// let duration = Duration::from_millis(5432);
355     /// assert_eq!(duration.as_secs(), 5);
356     /// assert_eq!(duration.subsec_millis(), 432);
357     /// ```
358     #[stable(feature = "duration_extras", since = "1.27.0")]
359     #[rustc_const_stable(feature = "duration_extras", since = "1.32.0")]
360     #[must_use]
361     #[inline]
362     pub const fn subsec_millis(&self) -> u32 {
363         self.nanos / NANOS_PER_MILLI
364     }
365
366     /// Returns the fractional part of this `Duration`, in whole microseconds.
367     ///
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).
371     ///
372     /// # Examples
373     ///
374     /// ```
375     /// use std::time::Duration;
376     ///
377     /// let duration = Duration::from_micros(1_234_567);
378     /// assert_eq!(duration.as_secs(), 1);
379     /// assert_eq!(duration.subsec_micros(), 234_567);
380     /// ```
381     #[stable(feature = "duration_extras", since = "1.27.0")]
382     #[rustc_const_stable(feature = "duration_extras", since = "1.32.0")]
383     #[must_use]
384     #[inline]
385     pub const fn subsec_micros(&self) -> u32 {
386         self.nanos / NANOS_PER_MICRO
387     }
388
389     /// Returns the fractional part of this `Duration`, in nanoseconds.
390     ///
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).
394     ///
395     /// # Examples
396     ///
397     /// ```
398     /// use std::time::Duration;
399     ///
400     /// let duration = Duration::from_millis(5010);
401     /// assert_eq!(duration.as_secs(), 5);
402     /// assert_eq!(duration.subsec_nanos(), 10_000_000);
403     /// ```
404     #[stable(feature = "duration", since = "1.3.0")]
405     #[rustc_const_stable(feature = "duration", since = "1.32.0")]
406     #[must_use]
407     #[inline]
408     pub const fn subsec_nanos(&self) -> u32 {
409         self.nanos
410     }
411
412     /// Returns the total number of whole milliseconds contained by this `Duration`.
413     ///
414     /// # Examples
415     ///
416     /// ```
417     /// use std::time::Duration;
418     ///
419     /// let duration = Duration::new(5, 730023852);
420     /// assert_eq!(duration.as_millis(), 5730);
421     /// ```
422     #[stable(feature = "duration_as_u128", since = "1.33.0")]
423     #[rustc_const_stable(feature = "duration_as_u128", since = "1.33.0")]
424     #[must_use]
425     #[inline]
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
428     }
429
430     /// Returns the total number of whole microseconds contained by this `Duration`.
431     ///
432     /// # Examples
433     ///
434     /// ```
435     /// use std::time::Duration;
436     ///
437     /// let duration = Duration::new(5, 730023852);
438     /// assert_eq!(duration.as_micros(), 5730023);
439     /// ```
440     #[stable(feature = "duration_as_u128", since = "1.33.0")]
441     #[rustc_const_stable(feature = "duration_as_u128", since = "1.33.0")]
442     #[must_use]
443     #[inline]
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
446     }
447
448     /// Returns the total number of nanoseconds contained by this `Duration`.
449     ///
450     /// # Examples
451     ///
452     /// ```
453     /// use std::time::Duration;
454     ///
455     /// let duration = Duration::new(5, 730023852);
456     /// assert_eq!(duration.as_nanos(), 5730023852);
457     /// ```
458     #[stable(feature = "duration_as_u128", since = "1.33.0")]
459     #[rustc_const_stable(feature = "duration_as_u128", since = "1.33.0")]
460     #[must_use]
461     #[inline]
462     pub const fn as_nanos(&self) -> u128 {
463         self.secs as u128 * NANOS_PER_SEC as u128 + self.nanos as u128
464     }
465
466     /// Checked `Duration` addition. Computes `self + other`, returning [`None`]
467     /// if overflow occurred.
468     ///
469     /// # Examples
470     ///
471     /// Basic usage:
472     ///
473     /// ```
474     /// use std::time::Duration;
475     ///
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);
478     /// ```
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"]
482     #[inline]
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) {
490                     secs = new_secs;
491                 } else {
492                     return None;
493                 }
494             }
495             debug_assert!(nanos < NANOS_PER_SEC);
496             Some(Duration { secs, nanos })
497         } else {
498             None
499         }
500     }
501
502     /// Saturating `Duration` addition. Computes `self + other`, returning [`Duration::MAX`]
503     /// if overflow occurred.
504     ///
505     /// # Examples
506     ///
507     /// ```
508     /// #![feature(duration_constants)]
509     /// use std::time::Duration;
510     ///
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);
513     /// ```
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"]
517     #[inline]
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) {
521             Some(res) => res,
522             None => Duration::MAX,
523         }
524     }
525
526     /// Checked `Duration` subtraction. Computes `self - other`, returning [`None`]
527     /// if the result would be negative or if overflow occurred.
528     ///
529     /// # Examples
530     ///
531     /// Basic usage:
532     ///
533     /// ```
534     /// use std::time::Duration;
535     ///
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);
538     /// ```
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"]
542     #[inline]
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) {
549                 secs = sub_secs;
550                 self.nanos + NANOS_PER_SEC - rhs.nanos
551             } else {
552                 return None;
553             };
554             debug_assert!(nanos < NANOS_PER_SEC);
555             Some(Duration { secs, nanos })
556         } else {
557             None
558         }
559     }
560
561     /// Saturating `Duration` subtraction. Computes `self - other`, returning [`Duration::ZERO`]
562     /// if the result would be negative or if overflow occurred.
563     ///
564     /// # Examples
565     ///
566     /// ```
567     /// use std::time::Duration;
568     ///
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);
571     /// ```
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"]
575     #[inline]
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) {
579             Some(res) => res,
580             None => Duration::ZERO,
581         }
582     }
583
584     /// Checked `Duration` multiplication. Computes `self * other`, returning
585     /// [`None`] if overflow occurred.
586     ///
587     /// # Examples
588     ///
589     /// Basic usage:
590     ///
591     /// ```
592     /// use std::time::Duration;
593     ///
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);
596     /// ```
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"]
600     #[inline]
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 });
611             }
612         }
613         None
614     }
615
616     /// Saturating `Duration` multiplication. Computes `self * other`, returning
617     /// [`Duration::MAX`] if overflow occurred.
618     ///
619     /// # Examples
620     ///
621     /// ```
622     /// #![feature(duration_constants)]
623     /// use std::time::Duration;
624     ///
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);
627     /// ```
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"]
631     #[inline]
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) {
635             Some(res) => res,
636             None => Duration::MAX,
637         }
638     }
639
640     /// Checked `Duration` division. Computes `self / other`, returning [`None`]
641     /// if `other == 0`.
642     ///
643     /// # Examples
644     ///
645     /// Basic usage:
646     ///
647     /// ```
648     /// use std::time::Duration;
649     ///
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);
653     /// ```
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"]
657     #[inline]
658     #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
659     pub const fn checked_div(self, rhs: u32) -> Option<Duration> {
660         if rhs != 0 {
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 })
667         } else {
668             None
669         }
670     }
671
672     /// Returns the number of seconds contained by this `Duration` as `f64`.
673     ///
674     /// The returned value does include the fractional (nanosecond) part of the duration.
675     ///
676     /// # Examples
677     /// ```
678     /// use std::time::Duration;
679     ///
680     /// let dur = Duration::new(2, 700_000_000);
681     /// assert_eq!(dur.as_secs_f64(), 2.7);
682     /// ```
683     #[stable(feature = "duration_float", since = "1.38.0")]
684     #[must_use]
685     #[inline]
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)
689     }
690
691     /// Returns the number of seconds contained by this `Duration` as `f32`.
692     ///
693     /// The returned value does include the fractional (nanosecond) part of the duration.
694     ///
695     /// # Examples
696     /// ```
697     /// use std::time::Duration;
698     ///
699     /// let dur = Duration::new(2, 700_000_000);
700     /// assert_eq!(dur.as_secs_f32(), 2.7);
701     /// ```
702     #[stable(feature = "duration_float", since = "1.38.0")]
703     #[must_use]
704     #[inline]
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)
708     }
709
710     /// Creates a new `Duration` from the specified number of seconds represented
711     /// as `f64`.
712     ///
713     /// # Panics
714     /// This constructor will panic if `secs` is not finite, negative or overflows `Duration`.
715     ///
716     /// # Examples
717     /// ```
718     /// use std::time::Duration;
719     ///
720     /// let dur = Duration::from_secs_f64(2.7);
721     /// assert_eq!(dur, Duration::new(2, 700_000_000));
722     /// ```
723     #[stable(feature = "duration_float", since = "1.38.0")]
724     #[must_use]
725     #[inline]
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) {
729             Ok(v) => v,
730             Err(e) => panic!("{}", e.description()),
731         }
732     }
733
734     /// The checked version of [`from_secs_f64`].
735     ///
736     /// [`from_secs_f64`]: Duration::from_secs_f64
737     ///
738     /// This constructor will return an `Err` if `secs` is not finite, negative or overflows `Duration`.
739     ///
740     /// # Examples
741     /// ```
742     /// #![feature(duration_checked_float)]
743     /// use std::time::Duration;
744     ///
745     /// let dur = Duration::try_from_secs_f64(2.7);
746     /// assert_eq!(dur, Ok(Duration::new(2, 700_000_000)));
747     ///
748     /// let negative = Duration::try_from_secs_f64(-5.0);
749     /// assert!(negative.is_err());
750     /// ```
751     #[unstable(feature = "duration_checked_float", issue = "83400")]
752     #[inline]
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 })
762         } else {
763             let nanos = nanos as u128;
764             Ok(Duration {
765                 secs: (nanos / (NANOS_PER_SEC as u128)) as u64,
766                 nanos: (nanos % (NANOS_PER_SEC as u128)) as u32,
767             })
768         }
769     }
770
771     /// Creates a new `Duration` from the specified number of seconds represented
772     /// as `f32`.
773     ///
774     /// # Panics
775     /// This constructor will panic if `secs` is not finite, negative or overflows `Duration`.
776     ///
777     /// # Examples
778     /// ```
779     /// use std::time::Duration;
780     ///
781     /// let dur = Duration::from_secs_f32(2.7);
782     /// assert_eq!(dur, Duration::new(2, 700_000_000));
783     /// ```
784     #[stable(feature = "duration_float", since = "1.38.0")]
785     #[must_use]
786     #[inline]
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) {
790             Ok(v) => v,
791             Err(e) => panic!("{}", e.description()),
792         }
793     }
794
795     /// The checked version of [`from_secs_f32`].
796     ///
797     /// [`from_secs_f32`]: Duration::from_secs_f32
798     ///
799     /// This constructor will return an `Err` if `secs` is not finite, negative or overflows `Duration`.
800     ///
801     /// # Examples
802     /// ```
803     /// #![feature(duration_checked_float)]
804     /// use std::time::Duration;
805     ///
806     /// let dur = Duration::try_from_secs_f32(2.7);
807     /// assert_eq!(dur, Ok(Duration::new(2, 700_000_000)));
808     ///
809     /// let negative = Duration::try_from_secs_f32(-5.0);
810     /// assert!(negative.is_err());
811     /// ```
812     #[unstable(feature = "duration_checked_float", issue = "83400")]
813     #[inline]
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 })
823         } else {
824             let nanos = nanos as u128;
825             Ok(Duration {
826                 secs: (nanos / (NANOS_PER_SEC as u128)) as u64,
827                 nanos: (nanos % (NANOS_PER_SEC as u128)) as u32,
828             })
829         }
830     }
831
832     /// Multiplies `Duration` by `f64`.
833     ///
834     /// # Panics
835     /// This method will panic if result is not finite, negative or overflows `Duration`.
836     ///
837     /// # Examples
838     /// ```
839     /// use std::time::Duration;
840     ///
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));
844     /// ```
845     #[stable(feature = "duration_float", since = "1.38.0")]
846     #[must_use = "this returns the result of the operation, \
847                   without modifying the original"]
848     #[inline]
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())
852     }
853
854     /// Multiplies `Duration` by `f32`.
855     ///
856     /// # Panics
857     /// This method will panic if result is not finite, negative or overflows `Duration`.
858     ///
859     /// # Examples
860     /// ```
861     /// use std::time::Duration;
862     ///
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));
868     /// ```
869     #[stable(feature = "duration_float", since = "1.38.0")]
870     #[must_use = "this returns the result of the operation, \
871                   without modifying the original"]
872     #[inline]
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())
876     }
877
878     /// Divide `Duration` by `f64`.
879     ///
880     /// # Panics
881     /// This method will panic if result is not finite, negative or overflows `Duration`.
882     ///
883     /// # Examples
884     /// ```
885     /// use std::time::Duration;
886     ///
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));
891     /// ```
892     #[stable(feature = "duration_float", since = "1.38.0")]
893     #[must_use = "this returns the result of the operation, \
894                   without modifying the original"]
895     #[inline]
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)
899     }
900
901     /// Divide `Duration` by `f32`.
902     ///
903     /// # Panics
904     /// This method will panic if result is not finite, negative or overflows `Duration`.
905     ///
906     /// # Examples
907     /// ```
908     /// use std::time::Duration;
909     ///
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));
916     /// ```
917     #[stable(feature = "duration_float", since = "1.38.0")]
918     #[must_use = "this returns the result of the operation, \
919                   without modifying the original"]
920     #[inline]
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)
924     }
925
926     /// Divide `Duration` by `Duration` and return `f64`.
927     ///
928     /// # Examples
929     /// ```
930     /// #![feature(div_duration)]
931     /// use std::time::Duration;
932     ///
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);
936     /// ```
937     #[unstable(feature = "div_duration", issue = "63139")]
938     #[must_use = "this returns the result of the operation, \
939                   without modifying the original"]
940     #[inline]
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()
944     }
945
946     /// Divide `Duration` by `Duration` and return `f32`.
947     ///
948     /// # Examples
949     /// ```
950     /// #![feature(div_duration)]
951     /// use std::time::Duration;
952     ///
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);
956     /// ```
957     #[unstable(feature = "div_duration", issue = "63139")]
958     #[must_use = "this returns the result of the operation, \
959                   without modifying the original"]
960     #[inline]
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()
964     }
965 }
966
967 #[stable(feature = "duration", since = "1.3.0")]
968 impl Add for Duration {
969     type Output = Duration;
970
971     fn add(self, rhs: Duration) -> Duration {
972         self.checked_add(rhs).expect("overflow when adding durations")
973     }
974 }
975
976 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
977 impl AddAssign for Duration {
978     fn add_assign(&mut self, rhs: Duration) {
979         *self = *self + rhs;
980     }
981 }
982
983 #[stable(feature = "duration", since = "1.3.0")]
984 impl Sub for Duration {
985     type Output = Duration;
986
987     fn sub(self, rhs: Duration) -> Duration {
988         self.checked_sub(rhs).expect("overflow when subtracting durations")
989     }
990 }
991
992 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
993 impl SubAssign for Duration {
994     fn sub_assign(&mut self, rhs: Duration) {
995         *self = *self - rhs;
996     }
997 }
998
999 #[stable(feature = "duration", since = "1.3.0")]
1000 impl Mul<u32> for Duration {
1001     type Output = Duration;
1002
1003     fn mul(self, rhs: u32) -> Duration {
1004         self.checked_mul(rhs).expect("overflow when multiplying duration by scalar")
1005     }
1006 }
1007
1008 #[stable(feature = "symmetric_u32_duration_mul", since = "1.31.0")]
1009 impl Mul<Duration> for u32 {
1010     type Output = Duration;
1011
1012     fn mul(self, rhs: Duration) -> Duration {
1013         rhs * self
1014     }
1015 }
1016
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;
1021     }
1022 }
1023
1024 #[stable(feature = "duration", since = "1.3.0")]
1025 impl Div<u32> for Duration {
1026     type Output = Duration;
1027
1028     fn div(self, rhs: u32) -> Duration {
1029         self.checked_div(rhs).expect("divide by zero error when dividing duration by scalar")
1030     }
1031 }
1032
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;
1037     }
1038 }
1039
1040 macro_rules! sum_durations {
1041     ($iter:expr) => {{
1042         let mut total_secs: u64 = 0;
1043         let mut total_nanos: u64 = 0;
1044
1045         for entry in $iter {
1046             total_secs =
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) {
1049                 Some(n) => n,
1050                 None => {
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
1055                 }
1056             };
1057         }
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 }
1063     }};
1064 }
1065
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)
1070     }
1071 }
1072
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)
1077     }
1078 }
1079
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.
1084         ///
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.
1089         ///
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`!
1093         ///
1094         /// A prefix and postfix may be added. The whole thing is padded
1095         /// to the formatter's `width`, if specified.
1096         fn fmt_decimal(
1097             f: &mut fmt::Formatter<'_>,
1098             mut integer_part: u64,
1099             mut fractional_part: u32,
1100             mut divisor: u32,
1101             prefix: &str,
1102             postfix: &str,
1103         ) -> fmt::Result {
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];
1109
1110             // The next digit is written at this position
1111             let mut pos = 0;
1112
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;
1118
1119                 fractional_part %= divisor;
1120                 divisor /= 10;
1121                 pos += 1;
1122             }
1123
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 {
1136                     rev_pos -= 1;
1137
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)
1141                     // and continue.
1142                     if buf[rev_pos] < b'9' {
1143                         buf[rev_pos] += 1;
1144                         carry = false;
1145                     } else {
1146                         buf[rev_pos] = b'0';
1147                     }
1148                 }
1149
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
1152                 // part.
1153                 if carry {
1154                     integer_part += 1;
1155                 }
1156             }
1157
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);
1162
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)?;
1167
1168                 // Write the decimal point and the fractional part (if any).
1169                 if end > 0 {
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]) };
1173
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)?;
1177                 }
1178
1179                 write!(f, "{}", postfix)
1180             };
1181
1182             match f.width() {
1183                 None => {
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)
1187                 }
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;
1199                     } else {
1200                         // integer_part is 0, so has length 1.
1201                         actual_w += 1;
1202                     }
1203                     // 4. The fractional part (if any):
1204                     if end > 0 {
1205                         let frac_part_w = f.precision().unwrap_or(pos);
1206                         actual_w += 1 + frac_part_w;
1207                     }
1208
1209                     if requested_w <= actual_w {
1210                         // Output is already longer than `width`, so don't pad.
1211                         emit_without_padding(f)
1212                     } else {
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)
1218                     }
1219                 }
1220             }
1221         }
1222
1223         // Print leading '+' sign if requested
1224         let prefix = if f.sign_plus() { "+" } else { "" };
1225
1226         if self.secs > 0 {
1227             fmt_decimal(f, self.secs, self.nanos, NANOS_PER_SEC / 10, prefix, "s")
1228         } else if self.nanos >= NANOS_PER_MILLI {
1229             fmt_decimal(
1230                 f,
1231                 (self.nanos / NANOS_PER_MILLI) as u64,
1232                 self.nanos % NANOS_PER_MILLI,
1233                 NANOS_PER_MILLI / 10,
1234                 prefix,
1235                 "ms",
1236             )
1237         } else if self.nanos >= NANOS_PER_MICRO {
1238             fmt_decimal(
1239                 f,
1240                 (self.nanos / NANOS_PER_MICRO) as u64,
1241                 self.nanos % NANOS_PER_MICRO,
1242                 NANOS_PER_MICRO / 10,
1243                 prefix,
1244                 "µs",
1245             )
1246         } else {
1247             fmt_decimal(f, self.nanos as u64, 0, 1, prefix, "ns")
1248         }
1249     }
1250 }
1251
1252 /// An error which can be returned when converting a floating-point value of seconds
1253 /// into a [`Duration`].
1254 ///
1255 /// This error is used as the error type for [`Duration::try_from_secs_f32`] and
1256 /// [`Duration::try_from_secs_f64`].
1257 ///
1258 /// # Example
1259 ///
1260 /// ```
1261 /// #![feature(duration_checked_float)]
1262 /// use std::time::Duration;
1263 ///
1264 /// if let Err(e) = Duration::try_from_secs_f32(-1.0) {
1265 ///     println!("Failed conversion to Duration: {}", e);
1266 /// }
1267 /// ```
1268 #[derive(Debug, Clone, PartialEq, Eq)]
1269 #[unstable(feature = "duration_checked_float", issue = "83400")]
1270 pub struct FromSecsError {
1271     kind: FromSecsErrorKind,
1272 }
1273
1274 impl FromSecsError {
1275     const fn description(&self) -> &'static str {
1276         match self.kind {
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",
1280         }
1281     }
1282 }
1283
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)
1288     }
1289 }
1290
1291 #[derive(Debug, Clone, PartialEq, Eq)]
1292 enum FromSecsErrorKind {
1293     // Value is not a finite value (either + or - infinity or NaN).
1294     NonFinite,
1295     // Value is too large to store in a `Duration`.
1296     Overflow,
1297     // Value is negative.
1298     Negative,
1299 }