core/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
22use crate::fmt;
23use crate::iter::Sum;
24use crate::num::niche_types::Nanoseconds;
25use crate::ops::{Add, AddAssign, Div, DivAssign, Mul, MulAssign, Sub, SubAssign};
26
27const NANOS_PER_SEC: u32 = 1_000_000_000;
28const NANOS_PER_MILLI: u32 = 1_000_000;
29const NANOS_PER_MICRO: u32 = 1_000;
30const MILLIS_PER_SEC: u64 = 1_000;
31const MICROS_PER_SEC: u64 = 1_000_000;
32#[unstable(feature = "duration_units", issue = "120301")]
33const SECS_PER_MINUTE: u64 = 60;
34#[unstable(feature = "duration_units", issue = "120301")]
35const MINS_PER_HOUR: u64 = 60;
36#[unstable(feature = "duration_units", issue = "120301")]
37const HOURS_PER_DAY: u64 = 24;
38#[unstable(feature = "duration_units", issue = "120301")]
39const DAYS_PER_WEEK: u64 = 7;
40
41/// A `Duration` type to represent a span of time, typically used for system
42/// timeouts.
43///
44/// Each `Duration` is composed of a whole number of seconds and a fractional part
45/// represented in nanoseconds. If the underlying system does not support
46/// nanosecond-level precision, APIs binding a system timeout will typically round up
47/// the number of nanoseconds.
48///
49/// [`Duration`]s implement many common traits, including [`Add`], [`Sub`], and other
50/// [`ops`] traits. It implements [`Default`] by returning a zero-length `Duration`.
51///
52/// [`ops`]: crate::ops
53///
54/// # Examples
55///
56/// ```
57/// use std::time::Duration;
58///
59/// let five_seconds = Duration::new(5, 0);
60/// let five_seconds_and_five_nanos = five_seconds + Duration::new(0, 5);
61///
62/// assert_eq!(five_seconds_and_five_nanos.as_secs(), 5);
63/// assert_eq!(five_seconds_and_five_nanos.subsec_nanos(), 5);
64///
65/// let ten_millis = Duration::from_millis(10);
66/// ```
67///
68/// # Formatting `Duration` values
69///
70/// `Duration` intentionally does not have a `Display` impl, as there are a
71/// variety of ways to format spans of time for human readability. `Duration`
72/// provides a `Debug` impl that shows the full precision of the value.
73///
74/// The `Debug` output uses the non-ASCII "µs" suffix for microseconds. If your
75/// program output may appear in contexts that cannot rely on full Unicode
76/// compatibility, you may wish to format `Duration` objects yourself or use a
77/// crate to do so.
78#[stable(feature = "duration", since = "1.3.0")]
79#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
80#[rustc_diagnostic_item = "Duration"]
81pub struct Duration {
82 secs: u64,
83 nanos: Nanoseconds, // Always 0 <= nanos < NANOS_PER_SEC
84}
85
86impl Duration {
87 /// The duration of one second.
88 ///
89 /// # Examples
90 ///
91 /// ```
92 /// #![feature(duration_constants)]
93 /// use std::time::Duration;
94 ///
95 /// assert_eq!(Duration::SECOND, Duration::from_secs(1));
96 /// ```
97 #[unstable(feature = "duration_constants", issue = "57391")]
98 pub const SECOND: Duration = Duration::from_secs(1);
99
100 /// The duration of one millisecond.
101 ///
102 /// # Examples
103 ///
104 /// ```
105 /// #![feature(duration_constants)]
106 /// use std::time::Duration;
107 ///
108 /// assert_eq!(Duration::MILLISECOND, Duration::from_millis(1));
109 /// ```
110 #[unstable(feature = "duration_constants", issue = "57391")]
111 pub const MILLISECOND: Duration = Duration::from_millis(1);
112
113 /// The duration of one microsecond.
114 ///
115 /// # Examples
116 ///
117 /// ```
118 /// #![feature(duration_constants)]
119 /// use std::time::Duration;
120 ///
121 /// assert_eq!(Duration::MICROSECOND, Duration::from_micros(1));
122 /// ```
123 #[unstable(feature = "duration_constants", issue = "57391")]
124 pub const MICROSECOND: Duration = Duration::from_micros(1);
125
126 /// The duration of one nanosecond.
127 ///
128 /// # Examples
129 ///
130 /// ```
131 /// #![feature(duration_constants)]
132 /// use std::time::Duration;
133 ///
134 /// assert_eq!(Duration::NANOSECOND, Duration::from_nanos(1));
135 /// ```
136 #[unstable(feature = "duration_constants", issue = "57391")]
137 pub const NANOSECOND: Duration = Duration::from_nanos(1);
138
139 /// A duration of zero time.
140 ///
141 /// # Examples
142 ///
143 /// ```
144 /// use std::time::Duration;
145 ///
146 /// let duration = Duration::ZERO;
147 /// assert!(duration.is_zero());
148 /// assert_eq!(duration.as_nanos(), 0);
149 /// ```
150 #[stable(feature = "duration_zero", since = "1.53.0")]
151 pub const ZERO: Duration = Duration::from_nanos(0);
152
153 /// The maximum duration.
154 ///
155 /// May vary by platform as necessary. Must be able to contain the difference between
156 /// two instances of [`Instant`] or two instances of [`SystemTime`].
157 /// This constraint gives it a value of about 584,942,417,355 years in practice,
158 /// which is currently used on all platforms.
159 ///
160 /// # Examples
161 ///
162 /// ```
163 /// use std::time::Duration;
164 ///
165 /// assert_eq!(Duration::MAX, Duration::new(u64::MAX, 1_000_000_000 - 1));
166 /// ```
167 /// [`Instant`]: ../../std/time/struct.Instant.html
168 /// [`SystemTime`]: ../../std/time/struct.SystemTime.html
169 #[stable(feature = "duration_saturating_ops", since = "1.53.0")]
170 pub const MAX: Duration = Duration::new(u64::MAX, NANOS_PER_SEC - 1);
171
172 /// Creates a new `Duration` from the specified number of whole seconds and
173 /// additional nanoseconds.
174 ///
175 /// If the number of nanoseconds is greater than 1 billion (the number of
176 /// nanoseconds in a second), then it will carry over into the seconds provided.
177 ///
178 /// # Panics
179 ///
180 /// This constructor will panic if the carry from the nanoseconds overflows
181 /// the seconds counter.
182 ///
183 /// # Examples
184 ///
185 /// ```
186 /// use std::time::Duration;
187 ///
188 /// let five_seconds = Duration::new(5, 0);
189 /// ```
190 #[stable(feature = "duration", since = "1.3.0")]
191 #[inline]
192 #[must_use]
193 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
194 pub const fn new(secs: u64, nanos: u32) -> Duration {
195 if nanos < NANOS_PER_SEC {
196 // SAFETY: nanos < NANOS_PER_SEC, therefore nanos is within the valid range
197 Duration { secs, nanos: unsafe { Nanoseconds::new_unchecked(nanos) } }
198 } else {
199 let secs = secs
200 .checked_add((nanos / NANOS_PER_SEC) as u64)
201 .expect("overflow in Duration::new");
202 let nanos = nanos % NANOS_PER_SEC;
203 // SAFETY: nanos % NANOS_PER_SEC < NANOS_PER_SEC, therefore nanos is within the valid range
204 Duration { secs, nanos: unsafe { Nanoseconds::new_unchecked(nanos) } }
205 }
206 }
207
208 /// Creates a new `Duration` from the specified number of whole seconds.
209 ///
210 /// # Examples
211 ///
212 /// ```
213 /// use std::time::Duration;
214 ///
215 /// let duration = Duration::from_secs(5);
216 ///
217 /// assert_eq!(5, duration.as_secs());
218 /// assert_eq!(0, duration.subsec_nanos());
219 /// ```
220 #[stable(feature = "duration", since = "1.3.0")]
221 #[must_use]
222 #[inline]
223 #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
224 pub const fn from_secs(secs: u64) -> Duration {
225 Duration { secs, nanos: Nanoseconds::ZERO }
226 }
227
228 /// Creates a new `Duration` from the specified number of milliseconds.
229 ///
230 /// # Examples
231 ///
232 /// ```
233 /// use std::time::Duration;
234 ///
235 /// let duration = Duration::from_millis(2_569);
236 ///
237 /// assert_eq!(2, duration.as_secs());
238 /// assert_eq!(569_000_000, duration.subsec_nanos());
239 /// ```
240 #[stable(feature = "duration", since = "1.3.0")]
241 #[must_use]
242 #[inline]
243 #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
244 pub const fn from_millis(millis: u64) -> Duration {
245 let secs = millis / MILLIS_PER_SEC;
246 let subsec_millis = (millis % MILLIS_PER_SEC) as u32;
247 // SAFETY: (x % 1_000) * 1_000_000 < 1_000_000_000
248 // => x % 1_000 < 1_000
249 let subsec_nanos = unsafe { Nanoseconds::new_unchecked(subsec_millis * NANOS_PER_MILLI) };
250
251 Duration { secs, nanos: subsec_nanos }
252 }
253
254 /// Creates a new `Duration` from the specified number of microseconds.
255 ///
256 /// # Examples
257 ///
258 /// ```
259 /// use std::time::Duration;
260 ///
261 /// let duration = Duration::from_micros(1_000_002);
262 ///
263 /// assert_eq!(1, duration.as_secs());
264 /// assert_eq!(2_000, duration.subsec_nanos());
265 /// ```
266 #[stable(feature = "duration_from_micros", since = "1.27.0")]
267 #[must_use]
268 #[inline]
269 #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
270 pub const fn from_micros(micros: u64) -> Duration {
271 let secs = micros / MICROS_PER_SEC;
272 let subsec_micros = (micros % MICROS_PER_SEC) as u32;
273 // SAFETY: (x % 1_000_000) * 1_000 < 1_000_000_000
274 // => x % 1_000_000 < 1_000_000
275 let subsec_nanos = unsafe { Nanoseconds::new_unchecked(subsec_micros * NANOS_PER_MICRO) };
276
277 Duration { secs, nanos: subsec_nanos }
278 }
279
280 /// Creates a new `Duration` from the specified number of nanoseconds.
281 ///
282 /// Note: Using this on the return value of `as_nanos()` might cause unexpected behavior:
283 /// `as_nanos()` returns a u128, and can return values that do not fit in u64, e.g. 585 years.
284 /// Instead, consider using the pattern `Duration::new(d.as_secs(), d.subsec_nanos())`
285 /// if you cannot copy/clone the Duration directly.
286 ///
287 /// # Examples
288 ///
289 /// ```
290 /// use std::time::Duration;
291 ///
292 /// let duration = Duration::from_nanos(1_000_000_123);
293 ///
294 /// assert_eq!(1, duration.as_secs());
295 /// assert_eq!(123, duration.subsec_nanos());
296 /// ```
297 #[stable(feature = "duration_extras", since = "1.27.0")]
298 #[must_use]
299 #[inline]
300 #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
301 pub const fn from_nanos(nanos: u64) -> Duration {
302 const NANOS_PER_SEC: u64 = self::NANOS_PER_SEC as u64;
303 let secs = nanos / NANOS_PER_SEC;
304 let subsec_nanos = (nanos % NANOS_PER_SEC) as u32;
305 // SAFETY: x % 1_000_000_000 < 1_000_000_000
306 let subsec_nanos = unsafe { Nanoseconds::new_unchecked(subsec_nanos) };
307
308 Duration { secs, nanos: subsec_nanos }
309 }
310
311 /// Creates a new `Duration` from the specified number of nanoseconds.
312 ///
313 /// # Panics
314 ///
315 /// Panics if the given number of nanoseconds is greater than [`Duration::MAX`].
316 ///
317 /// # Examples
318 ///
319 /// ```
320 /// use std::time::Duration;
321 ///
322 /// let nanos = 10_u128.pow(24) + 321;
323 /// let duration = Duration::from_nanos_u128(nanos);
324 ///
325 /// assert_eq!(10_u64.pow(15), duration.as_secs());
326 /// assert_eq!(321, duration.subsec_nanos());
327 /// ```
328 #[stable(feature = "duration_from_nanos_u128", since = "1.93.0")]
329 #[rustc_const_stable(feature = "duration_from_nanos_u128", since = "1.93.0")]
330 #[must_use]
331 #[inline]
332 #[track_caller]
333 #[rustc_allow_const_fn_unstable(const_trait_impl, const_convert)] // for `u64::try_from`
334 pub const fn from_nanos_u128(nanos: u128) -> Duration {
335 const NANOS_PER_SEC: u128 = self::NANOS_PER_SEC as u128;
336 let Ok(secs) = u64::try_from(nanos / NANOS_PER_SEC) else {
337 panic!("overflow in `Duration::from_nanos_u128`");
338 };
339 let subsec_nanos = (nanos % NANOS_PER_SEC) as u32;
340 // SAFETY: x % 1_000_000_000 < 1_000_000_000 also, subsec_nanos >= 0 since u128 >=0 and u32 >=0
341 let subsec_nanos = unsafe { Nanoseconds::new_unchecked(subsec_nanos) };
342
343 Duration { secs: secs as u64, nanos: subsec_nanos }
344 }
345
346 /// Creates a new `Duration` from the specified number of weeks.
347 ///
348 /// # Panics
349 ///
350 /// Panics if the given number of weeks overflows the `Duration` size.
351 ///
352 /// # Examples
353 ///
354 /// ```
355 /// #![feature(duration_constructors)]
356 /// use std::time::Duration;
357 ///
358 /// let duration = Duration::from_weeks(4);
359 ///
360 /// assert_eq!(4 * 7 * 24 * 60 * 60, duration.as_secs());
361 /// assert_eq!(0, duration.subsec_nanos());
362 /// ```
363 #[unstable(feature = "duration_constructors", issue = "120301")]
364 #[must_use]
365 #[inline]
366 pub const fn from_weeks(weeks: u64) -> Duration {
367 if weeks > u64::MAX / (SECS_PER_MINUTE * MINS_PER_HOUR * HOURS_PER_DAY * DAYS_PER_WEEK) {
368 panic!("overflow in Duration::from_weeks");
369 }
370
371 Duration::from_secs(weeks * MINS_PER_HOUR * SECS_PER_MINUTE * HOURS_PER_DAY * DAYS_PER_WEEK)
372 }
373
374 /// Creates a new `Duration` from the specified number of days.
375 ///
376 /// # Panics
377 ///
378 /// Panics if the given number of days overflows the `Duration` size.
379 ///
380 /// # Examples
381 ///
382 /// ```
383 /// #![feature(duration_constructors)]
384 /// use std::time::Duration;
385 ///
386 /// let duration = Duration::from_days(7);
387 ///
388 /// assert_eq!(7 * 24 * 60 * 60, duration.as_secs());
389 /// assert_eq!(0, duration.subsec_nanos());
390 /// ```
391 #[unstable(feature = "duration_constructors", issue = "120301")]
392 #[must_use]
393 #[inline]
394 pub const fn from_days(days: u64) -> Duration {
395 if days > u64::MAX / (SECS_PER_MINUTE * MINS_PER_HOUR * HOURS_PER_DAY) {
396 panic!("overflow in Duration::from_days");
397 }
398
399 Duration::from_secs(days * MINS_PER_HOUR * SECS_PER_MINUTE * HOURS_PER_DAY)
400 }
401
402 /// Creates a new `Duration` from the specified number of hours.
403 ///
404 /// # Panics
405 ///
406 /// Panics if the given number of hours overflows the `Duration` size.
407 ///
408 /// # Examples
409 ///
410 /// ```
411 /// use std::time::Duration;
412 ///
413 /// let duration = Duration::from_hours(6);
414 ///
415 /// assert_eq!(6 * 60 * 60, duration.as_secs());
416 /// assert_eq!(0, duration.subsec_nanos());
417 /// ```
418 #[stable(feature = "duration_constructors_lite", since = "1.91.0")]
419 #[rustc_const_stable(feature = "duration_constructors_lite", since = "1.91.0")]
420 #[must_use]
421 #[inline]
422 pub const fn from_hours(hours: u64) -> Duration {
423 if hours > u64::MAX / (SECS_PER_MINUTE * MINS_PER_HOUR) {
424 panic!("overflow in Duration::from_hours");
425 }
426
427 Duration::from_secs(hours * MINS_PER_HOUR * SECS_PER_MINUTE)
428 }
429
430 /// Creates a new `Duration` from the specified number of minutes.
431 ///
432 /// # Panics
433 ///
434 /// Panics if the given number of minutes overflows the `Duration` size.
435 ///
436 /// # Examples
437 ///
438 /// ```
439 /// use std::time::Duration;
440 ///
441 /// let duration = Duration::from_mins(10);
442 ///
443 /// assert_eq!(10 * 60, duration.as_secs());
444 /// assert_eq!(0, duration.subsec_nanos());
445 /// ```
446 #[stable(feature = "duration_constructors_lite", since = "1.91.0")]
447 #[rustc_const_stable(feature = "duration_constructors_lite", since = "1.91.0")]
448 #[must_use]
449 #[inline]
450 pub const fn from_mins(mins: u64) -> Duration {
451 if mins > u64::MAX / SECS_PER_MINUTE {
452 panic!("overflow in Duration::from_mins");
453 }
454
455 Duration::from_secs(mins * SECS_PER_MINUTE)
456 }
457
458 /// Returns true if this `Duration` spans no time.
459 ///
460 /// # Examples
461 ///
462 /// ```
463 /// use std::time::Duration;
464 ///
465 /// assert!(Duration::ZERO.is_zero());
466 /// assert!(Duration::new(0, 0).is_zero());
467 /// assert!(Duration::from_nanos(0).is_zero());
468 /// assert!(Duration::from_secs(0).is_zero());
469 ///
470 /// assert!(!Duration::new(1, 1).is_zero());
471 /// assert!(!Duration::from_nanos(1).is_zero());
472 /// assert!(!Duration::from_secs(1).is_zero());
473 /// ```
474 #[must_use]
475 #[stable(feature = "duration_zero", since = "1.53.0")]
476 #[rustc_const_stable(feature = "duration_zero", since = "1.53.0")]
477 #[inline]
478 pub const fn is_zero(&self) -> bool {
479 self.secs == 0 && self.nanos.as_inner() == 0
480 }
481
482 /// Returns the number of _whole_ seconds contained by this `Duration`.
483 ///
484 /// The returned value does not include the fractional (nanosecond) part of the
485 /// duration, which can be obtained using [`subsec_nanos`].
486 ///
487 /// # Examples
488 ///
489 /// ```
490 /// use std::time::Duration;
491 ///
492 /// let duration = Duration::new(5, 730_023_852);
493 /// assert_eq!(duration.as_secs(), 5);
494 /// ```
495 ///
496 /// To determine the total number of seconds represented by the `Duration`
497 /// including the fractional part, use [`as_secs_f64`] or [`as_secs_f32`]
498 ///
499 /// [`as_secs_f64`]: Duration::as_secs_f64
500 /// [`as_secs_f32`]: Duration::as_secs_f32
501 /// [`subsec_nanos`]: Duration::subsec_nanos
502 #[stable(feature = "duration", since = "1.3.0")]
503 #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
504 #[must_use]
505 #[inline]
506 pub const fn as_secs(&self) -> u64 {
507 self.secs
508 }
509
510 /// Returns the fractional part of this `Duration`, in whole milliseconds.
511 ///
512 /// This method does **not** return the length of the duration when
513 /// represented by milliseconds. The returned number always represents a
514 /// fractional portion of a second (i.e., it is less than one thousand).
515 ///
516 /// # Examples
517 ///
518 /// ```
519 /// use std::time::Duration;
520 ///
521 /// let duration = Duration::from_millis(5_432);
522 /// assert_eq!(duration.as_secs(), 5);
523 /// assert_eq!(duration.subsec_millis(), 432);
524 /// ```
525 #[stable(feature = "duration_extras", since = "1.27.0")]
526 #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
527 #[must_use]
528 #[inline]
529 pub const fn subsec_millis(&self) -> u32 {
530 self.nanos.as_inner() / NANOS_PER_MILLI
531 }
532
533 /// Returns the fractional part of this `Duration`, in whole microseconds.
534 ///
535 /// This method does **not** return the length of the duration when
536 /// represented by microseconds. The returned number always represents a
537 /// fractional portion of a second (i.e., it is less than one million).
538 ///
539 /// # Examples
540 ///
541 /// ```
542 /// use std::time::Duration;
543 ///
544 /// let duration = Duration::from_micros(1_234_567);
545 /// assert_eq!(duration.as_secs(), 1);
546 /// assert_eq!(duration.subsec_micros(), 234_567);
547 /// ```
548 #[stable(feature = "duration_extras", since = "1.27.0")]
549 #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
550 #[must_use]
551 #[inline]
552 pub const fn subsec_micros(&self) -> u32 {
553 self.nanos.as_inner() / NANOS_PER_MICRO
554 }
555
556 /// Returns the fractional part of this `Duration`, in nanoseconds.
557 ///
558 /// This method does **not** return the length of the duration when
559 /// represented by nanoseconds. The returned number always represents a
560 /// fractional portion of a second (i.e., it is less than one billion).
561 ///
562 /// # Examples
563 ///
564 /// ```
565 /// use std::time::Duration;
566 ///
567 /// let duration = Duration::from_millis(5_010);
568 /// assert_eq!(duration.as_secs(), 5);
569 /// assert_eq!(duration.subsec_nanos(), 10_000_000);
570 /// ```
571 #[stable(feature = "duration", since = "1.3.0")]
572 #[rustc_const_stable(feature = "duration_consts", since = "1.32.0")]
573 #[must_use]
574 #[inline]
575 pub const fn subsec_nanos(&self) -> u32 {
576 self.nanos.as_inner()
577 }
578
579 /// Returns the total number of whole milliseconds contained by this `Duration`.
580 ///
581 /// # Examples
582 ///
583 /// ```
584 /// use std::time::Duration;
585 ///
586 /// let duration = Duration::new(5, 730_023_852);
587 /// assert_eq!(duration.as_millis(), 5_730);
588 /// ```
589 #[stable(feature = "duration_as_u128", since = "1.33.0")]
590 #[rustc_const_stable(feature = "duration_as_u128", since = "1.33.0")]
591 #[must_use]
592 #[inline]
593 pub const fn as_millis(&self) -> u128 {
594 self.secs as u128 * MILLIS_PER_SEC as u128
595 + (self.nanos.as_inner() / NANOS_PER_MILLI) as u128
596 }
597
598 /// Returns the total number of whole microseconds contained by this `Duration`.
599 ///
600 /// # Examples
601 ///
602 /// ```
603 /// use std::time::Duration;
604 ///
605 /// let duration = Duration::new(5, 730_023_852);
606 /// assert_eq!(duration.as_micros(), 5_730_023);
607 /// ```
608 #[stable(feature = "duration_as_u128", since = "1.33.0")]
609 #[rustc_const_stable(feature = "duration_as_u128", since = "1.33.0")]
610 #[must_use]
611 #[inline]
612 pub const fn as_micros(&self) -> u128 {
613 self.secs as u128 * MICROS_PER_SEC as u128
614 + (self.nanos.as_inner() / NANOS_PER_MICRO) as u128
615 }
616
617 /// Returns the total number of nanoseconds contained by this `Duration`.
618 ///
619 /// # Examples
620 ///
621 /// ```
622 /// use std::time::Duration;
623 ///
624 /// let duration = Duration::new(5, 730_023_852);
625 /// assert_eq!(duration.as_nanos(), 5_730_023_852);
626 /// ```
627 #[stable(feature = "duration_as_u128", since = "1.33.0")]
628 #[rustc_const_stable(feature = "duration_as_u128", since = "1.33.0")]
629 #[must_use]
630 #[inline]
631 pub const fn as_nanos(&self) -> u128 {
632 self.secs as u128 * NANOS_PER_SEC as u128 + self.nanos.as_inner() as u128
633 }
634
635 /// Computes the absolute difference between `self` and `other`.
636 ///
637 /// # Examples
638 ///
639 /// ```
640 /// use std::time::Duration;
641 ///
642 /// assert_eq!(Duration::new(100, 0).abs_diff(Duration::new(80, 0)), Duration::new(20, 0));
643 /// assert_eq!(Duration::new(100, 400_000_000).abs_diff(Duration::new(110, 0)), Duration::new(9, 600_000_000));
644 /// ```
645 #[stable(feature = "duration_abs_diff", since = "1.81.0")]
646 #[rustc_const_stable(feature = "duration_abs_diff", since = "1.81.0")]
647 #[must_use = "this returns the result of the operation, \
648 without modifying the original"]
649 #[inline]
650 pub const fn abs_diff(self, other: Duration) -> Duration {
651 if let Some(res) = self.checked_sub(other) { res } else { other.checked_sub(self).unwrap() }
652 }
653
654 /// Checked `Duration` addition. Computes `self + other`, returning [`None`]
655 /// if overflow occurred.
656 ///
657 /// # Examples
658 ///
659 /// ```
660 /// use std::time::Duration;
661 ///
662 /// assert_eq!(Duration::new(0, 0).checked_add(Duration::new(0, 1)), Some(Duration::new(0, 1)));
663 /// assert_eq!(Duration::new(1, 0).checked_add(Duration::new(u64::MAX, 0)), None);
664 /// ```
665 #[stable(feature = "duration_checked_ops", since = "1.16.0")]
666 #[must_use = "this returns the result of the operation, \
667 without modifying the original"]
668 #[inline]
669 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
670 pub const fn checked_add(self, rhs: Duration) -> Option<Duration> {
671 if let Some(mut secs) = self.secs.checked_add(rhs.secs) {
672 let mut nanos = self.nanos.as_inner() + rhs.nanos.as_inner();
673 if nanos >= NANOS_PER_SEC {
674 nanos -= NANOS_PER_SEC;
675 let Some(new_secs) = secs.checked_add(1) else {
676 return None;
677 };
678 secs = new_secs;
679 }
680 debug_assert!(nanos < NANOS_PER_SEC);
681 Some(Duration::new(secs, nanos))
682 } else {
683 None
684 }
685 }
686
687 /// Saturating `Duration` addition. Computes `self + other`, returning [`Duration::MAX`]
688 /// if overflow occurred.
689 ///
690 /// # Examples
691 ///
692 /// ```
693 /// use std::time::Duration;
694 ///
695 /// assert_eq!(Duration::new(0, 0).saturating_add(Duration::new(0, 1)), Duration::new(0, 1));
696 /// assert_eq!(Duration::new(1, 0).saturating_add(Duration::new(u64::MAX, 0)), Duration::MAX);
697 /// ```
698 #[stable(feature = "duration_saturating_ops", since = "1.53.0")]
699 #[must_use = "this returns the result of the operation, \
700 without modifying the original"]
701 #[inline]
702 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
703 pub const fn saturating_add(self, rhs: Duration) -> Duration {
704 match self.checked_add(rhs) {
705 Some(res) => res,
706 None => Duration::MAX,
707 }
708 }
709
710 /// Checked `Duration` subtraction. Computes `self - other`, returning [`None`]
711 /// if the result would be negative or if overflow occurred.
712 ///
713 /// # Examples
714 ///
715 /// ```
716 /// use std::time::Duration;
717 ///
718 /// assert_eq!(Duration::new(0, 1).checked_sub(Duration::new(0, 0)), Some(Duration::new(0, 1)));
719 /// assert_eq!(Duration::new(0, 0).checked_sub(Duration::new(0, 1)), None);
720 /// ```
721 #[stable(feature = "duration_checked_ops", since = "1.16.0")]
722 #[must_use = "this returns the result of the operation, \
723 without modifying the original"]
724 #[inline]
725 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
726 pub const fn checked_sub(self, rhs: Duration) -> Option<Duration> {
727 if let Some(mut secs) = self.secs.checked_sub(rhs.secs) {
728 let nanos = if self.nanos.as_inner() >= rhs.nanos.as_inner() {
729 self.nanos.as_inner() - rhs.nanos.as_inner()
730 } else if let Some(sub_secs) = secs.checked_sub(1) {
731 secs = sub_secs;
732 self.nanos.as_inner() + NANOS_PER_SEC - rhs.nanos.as_inner()
733 } else {
734 return None;
735 };
736 debug_assert!(nanos < NANOS_PER_SEC);
737 Some(Duration::new(secs, nanos))
738 } else {
739 None
740 }
741 }
742
743 /// Saturating `Duration` subtraction. Computes `self - other`, returning [`Duration::ZERO`]
744 /// if the result would be negative or if overflow occurred.
745 ///
746 /// # Examples
747 ///
748 /// ```
749 /// use std::time::Duration;
750 ///
751 /// assert_eq!(Duration::new(0, 1).saturating_sub(Duration::new(0, 0)), Duration::new(0, 1));
752 /// assert_eq!(Duration::new(0, 0).saturating_sub(Duration::new(0, 1)), Duration::ZERO);
753 /// ```
754 #[stable(feature = "duration_saturating_ops", since = "1.53.0")]
755 #[must_use = "this returns the result of the operation, \
756 without modifying the original"]
757 #[inline]
758 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
759 pub const fn saturating_sub(self, rhs: Duration) -> Duration {
760 match self.checked_sub(rhs) {
761 Some(res) => res,
762 None => Duration::ZERO,
763 }
764 }
765
766 /// Checked `Duration` multiplication. Computes `self * other`, returning
767 /// [`None`] if overflow occurred.
768 ///
769 /// # Examples
770 ///
771 /// ```
772 /// use std::time::Duration;
773 ///
774 /// assert_eq!(Duration::new(0, 500_000_001).checked_mul(2), Some(Duration::new(1, 2)));
775 /// assert_eq!(Duration::new(u64::MAX - 1, 0).checked_mul(2), None);
776 /// ```
777 #[stable(feature = "duration_checked_ops", since = "1.16.0")]
778 #[must_use = "this returns the result of the operation, \
779 without modifying the original"]
780 #[inline]
781 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
782 pub const fn checked_mul(self, rhs: u32) -> Option<Duration> {
783 // Multiply nanoseconds as u64, because it cannot overflow that way.
784 let total_nanos = self.nanos.as_inner() as u64 * rhs as u64;
785 let extra_secs = total_nanos / (NANOS_PER_SEC as u64);
786 let nanos = (total_nanos % (NANOS_PER_SEC as u64)) as u32;
787 // FIXME(const-hack): use `and_then` once that is possible.
788 if let Some(s) = self.secs.checked_mul(rhs as u64) {
789 if let Some(secs) = s.checked_add(extra_secs) {
790 debug_assert!(nanos < NANOS_PER_SEC);
791 return Some(Duration::new(secs, nanos));
792 }
793 }
794 None
795 }
796
797 /// Saturating `Duration` multiplication. Computes `self * other`, returning
798 /// [`Duration::MAX`] if overflow occurred.
799 ///
800 /// # Examples
801 ///
802 /// ```
803 /// use std::time::Duration;
804 ///
805 /// assert_eq!(Duration::new(0, 500_000_001).saturating_mul(2), Duration::new(1, 2));
806 /// assert_eq!(Duration::new(u64::MAX - 1, 0).saturating_mul(2), Duration::MAX);
807 /// ```
808 #[stable(feature = "duration_saturating_ops", since = "1.53.0")]
809 #[must_use = "this returns the result of the operation, \
810 without modifying the original"]
811 #[inline]
812 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
813 pub const fn saturating_mul(self, rhs: u32) -> Duration {
814 match self.checked_mul(rhs) {
815 Some(res) => res,
816 None => Duration::MAX,
817 }
818 }
819
820 /// Checked `Duration` division. Computes `self / other`, returning [`None`]
821 /// if `other == 0`.
822 ///
823 /// # Examples
824 ///
825 /// ```
826 /// use std::time::Duration;
827 ///
828 /// assert_eq!(Duration::new(2, 0).checked_div(2), Some(Duration::new(1, 0)));
829 /// assert_eq!(Duration::new(1, 0).checked_div(2), Some(Duration::new(0, 500_000_000)));
830 /// assert_eq!(Duration::new(2, 0).checked_div(0), None);
831 /// ```
832 #[stable(feature = "duration_checked_ops", since = "1.16.0")]
833 #[must_use = "this returns the result of the operation, \
834 without modifying the original"]
835 #[inline]
836 #[rustc_const_stable(feature = "duration_consts_2", since = "1.58.0")]
837 pub const fn checked_div(self, rhs: u32) -> Option<Duration> {
838 if rhs != 0 {
839 let (secs, extra_secs) = (self.secs / (rhs as u64), self.secs % (rhs as u64));
840 let (mut nanos, extra_nanos) =
841 (self.nanos.as_inner() / rhs, self.nanos.as_inner() % rhs);
842 nanos +=
843 ((extra_secs * (NANOS_PER_SEC as u64) + extra_nanos as u64) / (rhs as u64)) as u32;
844 debug_assert!(nanos < NANOS_PER_SEC);
845 Some(Duration::new(secs, nanos))
846 } else {
847 None
848 }
849 }
850
851 /// Returns the number of seconds contained by this `Duration` as `f64`.
852 ///
853 /// The returned value includes the fractional (nanosecond) part of the duration.
854 ///
855 /// # Examples
856 /// ```
857 /// use std::time::Duration;
858 ///
859 /// let dur = Duration::new(2, 700_000_000);
860 /// assert_eq!(dur.as_secs_f64(), 2.7);
861 /// ```
862 #[stable(feature = "duration_float", since = "1.38.0")]
863 #[must_use]
864 #[inline]
865 #[rustc_const_stable(feature = "duration_consts_float", since = "1.83.0")]
866 pub const fn as_secs_f64(&self) -> f64 {
867 (self.secs as f64) + (self.nanos.as_inner() as f64) / (NANOS_PER_SEC as f64)
868 }
869
870 /// Returns the number of seconds contained by this `Duration` as `f32`.
871 ///
872 /// The returned value includes the fractional (nanosecond) part of the duration.
873 ///
874 /// # Examples
875 /// ```
876 /// use std::time::Duration;
877 ///
878 /// let dur = Duration::new(2, 700_000_000);
879 /// assert_eq!(dur.as_secs_f32(), 2.7);
880 /// ```
881 #[stable(feature = "duration_float", since = "1.38.0")]
882 #[must_use]
883 #[inline]
884 #[rustc_const_stable(feature = "duration_consts_float", since = "1.83.0")]
885 pub const fn as_secs_f32(&self) -> f32 {
886 (self.secs as f32) + (self.nanos.as_inner() as f32) / (NANOS_PER_SEC as f32)
887 }
888
889 /// Returns the number of milliseconds contained by this `Duration` as `f64`.
890 ///
891 /// The returned value includes the fractional (nanosecond) part of the duration.
892 ///
893 /// # Examples
894 /// ```
895 /// #![feature(duration_millis_float)]
896 /// use std::time::Duration;
897 ///
898 /// let dur = Duration::new(2, 345_678_000);
899 /// assert_eq!(dur.as_millis_f64(), 2_345.678);
900 /// ```
901 #[unstable(feature = "duration_millis_float", issue = "122451")]
902 #[must_use]
903 #[inline]
904 pub const fn as_millis_f64(&self) -> f64 {
905 (self.secs as f64) * (MILLIS_PER_SEC as f64)
906 + (self.nanos.as_inner() as f64) / (NANOS_PER_MILLI as f64)
907 }
908
909 /// Returns the number of milliseconds contained by this `Duration` as `f32`.
910 ///
911 /// The returned value includes the fractional (nanosecond) part of the duration.
912 ///
913 /// # Examples
914 /// ```
915 /// #![feature(duration_millis_float)]
916 /// use std::time::Duration;
917 ///
918 /// let dur = Duration::new(2, 345_678_000);
919 /// assert_eq!(dur.as_millis_f32(), 2_345.678);
920 /// ```
921 #[unstable(feature = "duration_millis_float", issue = "122451")]
922 #[must_use]
923 #[inline]
924 pub const fn as_millis_f32(&self) -> f32 {
925 (self.secs as f32) * (MILLIS_PER_SEC as f32)
926 + (self.nanos.as_inner() as f32) / (NANOS_PER_MILLI as f32)
927 }
928
929 /// Creates a new `Duration` from the specified number of seconds represented
930 /// as `f64`.
931 ///
932 /// # Panics
933 /// This constructor will panic if `secs` is negative, overflows `Duration` or not finite.
934 ///
935 /// # Examples
936 /// ```
937 /// use std::time::Duration;
938 ///
939 /// let res = Duration::from_secs_f64(0.0);
940 /// assert_eq!(res, Duration::new(0, 0));
941 /// let res = Duration::from_secs_f64(1e-20);
942 /// assert_eq!(res, Duration::new(0, 0));
943 /// let res = Duration::from_secs_f64(4.2e-7);
944 /// assert_eq!(res, Duration::new(0, 420));
945 /// let res = Duration::from_secs_f64(2.7);
946 /// assert_eq!(res, Duration::new(2, 700_000_000));
947 /// let res = Duration::from_secs_f64(3e10);
948 /// assert_eq!(res, Duration::new(30_000_000_000, 0));
949 /// // subnormal float
950 /// let res = Duration::from_secs_f64(f64::from_bits(1));
951 /// assert_eq!(res, Duration::new(0, 0));
952 /// // conversion uses rounding
953 /// let res = Duration::from_secs_f64(0.999e-9);
954 /// assert_eq!(res, Duration::new(0, 1));
955 /// ```
956 #[stable(feature = "duration_float", since = "1.38.0")]
957 #[must_use]
958 #[inline]
959 pub fn from_secs_f64(secs: f64) -> Duration {
960 match Duration::try_from_secs_f64(secs) {
961 Ok(v) => v,
962 Err(e) => panic!("{e}"),
963 }
964 }
965
966 /// Creates a new `Duration` from the specified number of seconds represented
967 /// as `f32`.
968 ///
969 /// # Panics
970 /// This constructor will panic if `secs` is negative, overflows `Duration` or not finite.
971 ///
972 /// # Examples
973 /// ```
974 /// use std::time::Duration;
975 ///
976 /// let res = Duration::from_secs_f32(0.0);
977 /// assert_eq!(res, Duration::new(0, 0));
978 /// let res = Duration::from_secs_f32(1e-20);
979 /// assert_eq!(res, Duration::new(0, 0));
980 /// let res = Duration::from_secs_f32(4.2e-7);
981 /// assert_eq!(res, Duration::new(0, 420));
982 /// let res = Duration::from_secs_f32(2.7);
983 /// assert_eq!(res, Duration::new(2, 700_000_048));
984 /// let res = Duration::from_secs_f32(3e10);
985 /// assert_eq!(res, Duration::new(30_000_001_024, 0));
986 /// // subnormal float
987 /// let res = Duration::from_secs_f32(f32::from_bits(1));
988 /// assert_eq!(res, Duration::new(0, 0));
989 /// // conversion uses rounding
990 /// let res = Duration::from_secs_f32(0.999e-9);
991 /// assert_eq!(res, Duration::new(0, 1));
992 /// ```
993 #[stable(feature = "duration_float", since = "1.38.0")]
994 #[must_use]
995 #[inline]
996 pub fn from_secs_f32(secs: f32) -> Duration {
997 match Duration::try_from_secs_f32(secs) {
998 Ok(v) => v,
999 Err(e) => panic!("{e}"),
1000 }
1001 }
1002
1003 /// Multiplies `Duration` by `f64`.
1004 ///
1005 /// # Panics
1006 /// This method will panic if result is negative, overflows `Duration` or not finite.
1007 ///
1008 /// # Examples
1009 ///
1010 /// ```
1011 /// use std::time::Duration;
1012 ///
1013 /// let dur = Duration::new(2, 700_000_000);
1014 /// assert_eq!(dur.mul_f64(3.14), Duration::new(8, 478_000_000));
1015 /// assert_eq!(dur.mul_f64(3.14e5), Duration::new(847_800, 0));
1016 /// ```
1017 ///
1018 /// Note that `f64` does not have enough bits ([`f64::MANTISSA_DIGITS`]) to represent the full
1019 /// range of possible `Duration` with nanosecond precision, so rounding may occur even for
1020 /// trivial operations like multiplying by 1.
1021 ///
1022 /// ```
1023 /// # #![feature(float_exact_integer_constants)]
1024 /// use std::time::Duration;
1025 ///
1026 /// // This is about 14.9 weeks, remaining precise to the nanosecond:
1027 /// let weeks = Duration::from_nanos(f64::MAX_EXACT_INTEGER as u64);
1028 /// assert_eq!(weeks, weeks.mul_f64(1.0));
1029 ///
1030 /// // A larger value incurs rounding in the floating-point operation:
1031 /// let weeks = Duration::from_nanos(u64::MAX);
1032 /// assert_ne!(weeks, weeks.mul_f64(1.0));
1033 ///
1034 /// // This is over 285 million years, remaining precise to the second:
1035 /// let years = Duration::from_secs(f64::MAX_EXACT_INTEGER as u64);
1036 /// assert_eq!(years, years.mul_f64(1.0));
1037 ///
1038 /// // And again larger values incur rounding:
1039 /// let years = Duration::from_secs(u64::MAX / 2);
1040 /// assert_ne!(years, years.mul_f64(1.0));
1041 /// ```
1042 ///
1043 /// ```should_panic
1044 /// # use std::time::Duration;
1045 /// // In the extreme, rounding can even overflow `Duration`, which panics.
1046 /// let _ = Duration::from_secs(u64::MAX).mul_f64(1.0);
1047 /// ```
1048 #[stable(feature = "duration_float", since = "1.38.0")]
1049 #[must_use = "this returns the result of the operation, \
1050 without modifying the original"]
1051 #[inline]
1052 pub fn mul_f64(self, rhs: f64) -> Duration {
1053 Duration::from_secs_f64(rhs * self.as_secs_f64())
1054 }
1055
1056 /// Multiplies `Duration` by `f32`.
1057 ///
1058 /// Since the significand of `f32` is quite limited compared to the range of `Duration`
1059 /// -- only about 16.8ms of exact nanosecond precision -- this method currently forwards
1060 /// to [`mul_f64`][Self::mul_f64] for greater accuracy.
1061 ///
1062 /// # Panics
1063 /// This method will panic if result is negative, overflows `Duration` or not finite.
1064 ///
1065 /// # Examples
1066 /// ```
1067 /// use std::time::Duration;
1068 ///
1069 /// let dur = Duration::new(2, 700_000_000);
1070 /// // Note that this `3.14_f32` argument already has more floating-point
1071 /// // representation error than a direct `3.14_f64` would, so the result
1072 /// // is slightly different from the ideal 8.478s.
1073 /// assert_eq!(dur.mul_f32(3.14), Duration::new(8, 478_000_283));
1074 /// assert_eq!(dur.mul_f32(3.14e5), Duration::new(847_800, 0));
1075 /// ```
1076 #[stable(feature = "duration_float", since = "1.38.0")]
1077 #[must_use = "this returns the result of the operation, \
1078 without modifying the original"]
1079 #[inline]
1080 pub fn mul_f32(self, rhs: f32) -> Duration {
1081 self.mul_f64(rhs.into())
1082 }
1083
1084 /// Divides `Duration` by `f64`.
1085 ///
1086 /// # Panics
1087 /// This method will panic if result is negative, overflows `Duration` or not finite.
1088 ///
1089 /// # Examples
1090 ///
1091 /// ```
1092 /// use std::time::Duration;
1093 ///
1094 /// let dur = Duration::new(2, 700_000_000);
1095 /// assert_eq!(dur.div_f64(3.14), Duration::new(0, 859_872_611));
1096 /// assert_eq!(dur.div_f64(3.14e5), Duration::new(0, 8_599));
1097 /// ```
1098 ///
1099 /// Note that `f64` does not have enough bits ([`f64::MANTISSA_DIGITS`]) to represent the full
1100 /// range of possible `Duration` with nanosecond precision, so rounding may occur even for
1101 /// trivial operations like dividing by 1.
1102 ///
1103 /// ```
1104 /// # #![feature(float_exact_integer_constants)]
1105 /// use std::time::Duration;
1106 ///
1107 /// // This is about 14.9 weeks, remaining precise to the nanosecond:
1108 /// let weeks = Duration::from_nanos(f64::MAX_EXACT_INTEGER as u64);
1109 /// assert_eq!(weeks, weeks.div_f64(1.0));
1110 ///
1111 /// // A larger value incurs rounding in the floating-point operation:
1112 /// let weeks = Duration::from_nanos(u64::MAX);
1113 /// assert_ne!(weeks, weeks.div_f64(1.0));
1114 ///
1115 /// // This is over 285 million years, remaining precise to the second:
1116 /// let years = Duration::from_secs(f64::MAX_EXACT_INTEGER as u64);
1117 /// assert_eq!(years, years.div_f64(1.0));
1118 ///
1119 /// // And again larger values incur rounding:
1120 /// let years = Duration::from_secs(u64::MAX / 2);
1121 /// assert_ne!(years, years.div_f64(1.0));
1122 /// ```
1123 ///
1124 /// ```should_panic
1125 /// # use std::time::Duration;
1126 /// // In the extreme, rounding can even overflow `Duration`, which panics.
1127 /// let _ = Duration::from_secs(u64::MAX).div_f64(1.0);
1128 /// ```
1129 #[stable(feature = "duration_float", since = "1.38.0")]
1130 #[must_use = "this returns the result of the operation, \
1131 without modifying the original"]
1132 #[inline]
1133 pub fn div_f64(self, rhs: f64) -> Duration {
1134 Duration::from_secs_f64(self.as_secs_f64() / rhs)
1135 }
1136
1137 /// Divides `Duration` by `f32`.
1138 ///
1139 /// Since the significand of `f32` is quite limited compared to the range of `Duration`
1140 /// -- only about 16.8ms of exact nanosecond precision -- this method currently forwards
1141 /// to [`div_f64`][Self::div_f64] for greater accuracy.
1142 ///
1143 /// # Panics
1144 /// This method will panic if result is negative, overflows `Duration` or not finite.
1145 ///
1146 /// # Examples
1147 /// ```
1148 /// use std::time::Duration;
1149 ///
1150 /// let dur = Duration::new(2, 700_000_000);
1151 /// // Note that this `3.14_f32` argument already has more floating-point
1152 /// // representation error than a direct `3.14_f64` would, so the result
1153 /// // is slightly different from the ideally rounded 0.859_872_611.
1154 /// assert_eq!(dur.div_f32(3.14), Duration::new(0, 859_872_583));
1155 /// assert_eq!(dur.div_f32(3.14e5), Duration::new(0, 8_599));
1156 /// ```
1157 #[stable(feature = "duration_float", since = "1.38.0")]
1158 #[must_use = "this returns the result of the operation, \
1159 without modifying the original"]
1160 #[inline]
1161 pub fn div_f32(self, rhs: f32) -> Duration {
1162 self.div_f64(rhs.into())
1163 }
1164
1165 /// Divides `Duration` by `Duration` and returns `f64`.
1166 ///
1167 /// # Examples
1168 /// ```
1169 /// use std::time::Duration;
1170 ///
1171 /// let dur1 = Duration::new(2, 700_000_000);
1172 /// let dur2 = Duration::new(5, 400_000_000);
1173 /// assert_eq!(dur1.div_duration_f64(dur2), 0.5);
1174 /// ```
1175 #[stable(feature = "div_duration", since = "1.80.0")]
1176 #[must_use = "this returns the result of the operation, \
1177 without modifying the original"]
1178 #[inline]
1179 #[rustc_const_stable(feature = "duration_consts_float", since = "1.83.0")]
1180 pub const fn div_duration_f64(self, rhs: Duration) -> f64 {
1181 let self_nanos =
1182 (self.secs as f64) * (NANOS_PER_SEC as f64) + (self.nanos.as_inner() as f64);
1183 let rhs_nanos = (rhs.secs as f64) * (NANOS_PER_SEC as f64) + (rhs.nanos.as_inner() as f64);
1184 self_nanos / rhs_nanos
1185 }
1186
1187 /// Divides `Duration` by `Duration` and returns `f32`.
1188 ///
1189 /// # Examples
1190 /// ```
1191 /// use std::time::Duration;
1192 ///
1193 /// let dur1 = Duration::new(2, 700_000_000);
1194 /// let dur2 = Duration::new(5, 400_000_000);
1195 /// assert_eq!(dur1.div_duration_f32(dur2), 0.5);
1196 /// ```
1197 #[stable(feature = "div_duration", since = "1.80.0")]
1198 #[must_use = "this returns the result of the operation, \
1199 without modifying the original"]
1200 #[inline]
1201 #[rustc_const_stable(feature = "duration_consts_float", since = "1.83.0")]
1202 pub const fn div_duration_f32(self, rhs: Duration) -> f32 {
1203 let self_nanos =
1204 (self.secs as f32) * (NANOS_PER_SEC as f32) + (self.nanos.as_inner() as f32);
1205 let rhs_nanos = (rhs.secs as f32) * (NANOS_PER_SEC as f32) + (rhs.nanos.as_inner() as f32);
1206 self_nanos / rhs_nanos
1207 }
1208
1209 /// Divides `Duration` by `Duration` and returns `u128`, rounding the result towards zero.
1210 ///
1211 /// # Examples
1212 /// ```
1213 /// #![feature(duration_integer_division)]
1214 /// use std::time::Duration;
1215 ///
1216 /// let dur = Duration::new(2, 0);
1217 /// assert_eq!(dur.div_duration_floor(Duration::new(1, 000_000_001)), 1);
1218 /// assert_eq!(dur.div_duration_floor(Duration::new(1, 000_000_000)), 2);
1219 /// assert_eq!(dur.div_duration_floor(Duration::new(0, 999_999_999)), 2);
1220 /// ```
1221 #[unstable(feature = "duration_integer_division", issue = "149573")]
1222 #[must_use = "this returns the result of the operation, \
1223 without modifying the original"]
1224 #[inline]
1225 pub const fn div_duration_floor(self, rhs: Duration) -> u128 {
1226 self.as_nanos().div_floor(rhs.as_nanos())
1227 }
1228
1229 /// Divides `Duration` by `Duration` and returns `u128`, rounding the result towards positive infinity.
1230 ///
1231 /// # Examples
1232 /// ```
1233 /// #![feature(duration_integer_division)]
1234 /// use std::time::Duration;
1235 ///
1236 /// let dur = Duration::new(2, 0);
1237 /// assert_eq!(dur.div_duration_ceil(Duration::new(1, 000_000_001)), 2);
1238 /// assert_eq!(dur.div_duration_ceil(Duration::new(1, 000_000_000)), 2);
1239 /// assert_eq!(dur.div_duration_ceil(Duration::new(0, 999_999_999)), 3);
1240 /// ```
1241 #[unstable(feature = "duration_integer_division", issue = "149573")]
1242 #[must_use = "this returns the result of the operation, \
1243 without modifying the original"]
1244 #[inline]
1245 pub const fn div_duration_ceil(self, rhs: Duration) -> u128 {
1246 self.as_nanos().div_ceil(rhs.as_nanos())
1247 }
1248}
1249
1250#[stable(feature = "duration", since = "1.3.0")]
1251#[rustc_const_unstable(feature = "const_ops", issue = "143802")]
1252impl const Add for Duration {
1253 type Output = Duration;
1254
1255 #[inline]
1256 fn add(self, rhs: Duration) -> Duration {
1257 self.checked_add(rhs).expect("overflow when adding durations")
1258 }
1259}
1260
1261#[stable(feature = "time_augmented_assignment", since = "1.9.0")]
1262#[rustc_const_unstable(feature = "const_ops", issue = "143802")]
1263impl const AddAssign for Duration {
1264 #[inline]
1265 fn add_assign(&mut self, rhs: Duration) {
1266 *self = *self + rhs;
1267 }
1268}
1269
1270#[stable(feature = "duration", since = "1.3.0")]
1271#[rustc_const_unstable(feature = "const_ops", issue = "143802")]
1272impl const Sub for Duration {
1273 type Output = Duration;
1274
1275 #[inline]
1276 fn sub(self, rhs: Duration) -> Duration {
1277 self.checked_sub(rhs).expect("overflow when subtracting durations")
1278 }
1279}
1280
1281#[stable(feature = "time_augmented_assignment", since = "1.9.0")]
1282#[rustc_const_unstable(feature = "const_ops", issue = "143802")]
1283impl const SubAssign for Duration {
1284 #[inline]
1285 fn sub_assign(&mut self, rhs: Duration) {
1286 *self = *self - rhs;
1287 }
1288}
1289
1290#[stable(feature = "duration", since = "1.3.0")]
1291#[rustc_const_unstable(feature = "const_ops", issue = "143802")]
1292impl const Mul<u32> for Duration {
1293 type Output = Duration;
1294
1295 #[inline]
1296 fn mul(self, rhs: u32) -> Duration {
1297 self.checked_mul(rhs).expect("overflow when multiplying duration by scalar")
1298 }
1299}
1300
1301#[stable(feature = "symmetric_u32_duration_mul", since = "1.31.0")]
1302#[rustc_const_unstable(feature = "const_ops", issue = "143802")]
1303impl const Mul<Duration> for u32 {
1304 type Output = Duration;
1305
1306 #[inline]
1307 fn mul(self, rhs: Duration) -> Duration {
1308 rhs * self
1309 }
1310}
1311
1312#[stable(feature = "time_augmented_assignment", since = "1.9.0")]
1313#[rustc_const_unstable(feature = "const_ops", issue = "143802")]
1314impl const MulAssign<u32> for Duration {
1315 #[inline]
1316 fn mul_assign(&mut self, rhs: u32) {
1317 *self = *self * rhs;
1318 }
1319}
1320
1321#[stable(feature = "duration", since = "1.3.0")]
1322#[rustc_const_unstable(feature = "const_ops", issue = "143802")]
1323impl const Div<u32> for Duration {
1324 type Output = Duration;
1325
1326 #[inline]
1327 #[track_caller]
1328 fn div(self, rhs: u32) -> Duration {
1329 self.checked_div(rhs).expect("divide by zero error when dividing duration by scalar")
1330 }
1331}
1332
1333#[stable(feature = "time_augmented_assignment", since = "1.9.0")]
1334#[rustc_const_unstable(feature = "const_ops", issue = "143802")]
1335impl const DivAssign<u32> for Duration {
1336 #[inline]
1337 #[track_caller]
1338 fn div_assign(&mut self, rhs: u32) {
1339 *self = *self / rhs;
1340 }
1341}
1342
1343macro_rules! sum_durations {
1344 ($iter:expr) => {{
1345 let mut total_secs: u64 = 0;
1346 let mut total_nanos: u64 = 0;
1347
1348 for entry in $iter {
1349 total_secs =
1350 total_secs.checked_add(entry.secs).expect("overflow in iter::sum over durations");
1351 total_nanos = match total_nanos.checked_add(entry.nanos.as_inner() as u64) {
1352 Some(n) => n,
1353 None => {
1354 total_secs = total_secs
1355 .checked_add(total_nanos / NANOS_PER_SEC as u64)
1356 .expect("overflow in iter::sum over durations");
1357 (total_nanos % NANOS_PER_SEC as u64) + entry.nanos.as_inner() as u64
1358 }
1359 };
1360 }
1361 total_secs = total_secs
1362 .checked_add(total_nanos / NANOS_PER_SEC as u64)
1363 .expect("overflow in iter::sum over durations");
1364 total_nanos = total_nanos % NANOS_PER_SEC as u64;
1365 Duration::new(total_secs, total_nanos as u32)
1366 }};
1367}
1368
1369#[stable(feature = "duration_sum", since = "1.16.0")]
1370impl Sum for Duration {
1371 fn sum<I: Iterator<Item = Duration>>(iter: I) -> Duration {
1372 sum_durations!(iter)
1373 }
1374}
1375
1376#[stable(feature = "duration_sum", since = "1.16.0")]
1377impl<'a> Sum<&'a Duration> for Duration {
1378 fn sum<I: Iterator<Item = &'a Duration>>(iter: I) -> Duration {
1379 sum_durations!(iter)
1380 }
1381}
1382
1383#[stable(feature = "duration_debug_impl", since = "1.27.0")]
1384impl fmt::Debug for Duration {
1385 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1386 /// Formats a floating point number in decimal notation.
1387 ///
1388 /// The number is given as the `integer_part` and a fractional part.
1389 /// The value of the fractional part is `fractional_part / divisor`. So
1390 /// `integer_part` = 3, `fractional_part` = 12 and `divisor` = 100
1391 /// represents the number `3.012`. Trailing zeros are omitted.
1392 ///
1393 /// `divisor` must not be above 100_000_000. It also should be a power
1394 /// of 10, everything else doesn't make sense. `fractional_part` has
1395 /// to be less than `10 * divisor`!
1396 ///
1397 /// A prefix and postfix may be added. The whole thing is padded
1398 /// to the formatter's `width`, if specified.
1399 fn fmt_decimal(
1400 f: &mut fmt::Formatter<'_>,
1401 integer_part: u64,
1402 mut fractional_part: u32,
1403 mut divisor: u32,
1404 prefix: &str,
1405 postfix: &str,
1406 ) -> fmt::Result {
1407 // Encode the fractional part into a temporary buffer. The buffer
1408 // only need to hold 9 elements, because `fractional_part` has to
1409 // be smaller than 10^9. The buffer is prefilled with '0' digits
1410 // to simplify the code below.
1411 let mut buf = [b'0'; 9];
1412
1413 // The next digit is written at this position
1414 let mut pos = 0;
1415
1416 // We keep writing digits into the buffer while there are non-zero
1417 // digits left and we haven't written enough digits yet.
1418 while fractional_part > 0 && pos < f.precision().unwrap_or(9) {
1419 // Write new digit into the buffer
1420 buf[pos] = b'0' + (fractional_part / divisor) as u8;
1421
1422 fractional_part %= divisor;
1423 divisor /= 10;
1424 pos += 1;
1425 }
1426
1427 // If a precision < 9 was specified, there may be some non-zero
1428 // digits left that weren't written into the buffer. In that case we
1429 // need to perform rounding to match the semantics of printing
1430 // normal floating point numbers. However, we only need to do work
1431 // when rounding up. This happens if the first digit of the
1432 // remaining ones is >= 5. When the first digit is exactly 5, rounding
1433 // follows IEEE-754 round-ties-to-even semantics: we only round up
1434 // if the last written digit is odd.
1435 let integer_part = if fractional_part > 0 && fractional_part >= divisor * 5 {
1436 // For ties (fractional_part == divisor * 5), only round up if last digit is odd
1437 let is_tie = fractional_part == divisor * 5;
1438 let last_digit_is_odd = if pos > 0 {
1439 (buf[pos - 1] - b'0') % 2 == 1
1440 } else {
1441 // No fractional digits - check the integer part
1442 (integer_part % 2) == 1
1443 };
1444
1445 if is_tie && !last_digit_is_odd {
1446 Some(integer_part)
1447 } else {
1448 // Round up the number contained in the buffer. We go through
1449 // the buffer backwards and keep track of the carry.
1450 let mut rev_pos = pos;
1451 let mut carry = true;
1452 while carry && rev_pos > 0 {
1453 rev_pos -= 1;
1454
1455 // If the digit in the buffer is not '9', we just need to
1456 // increment it and can stop then (since we don't have a
1457 // carry anymore). Otherwise, we set it to '0' (overflow)
1458 // and continue.
1459 if buf[rev_pos] < b'9' {
1460 buf[rev_pos] += 1;
1461 carry = false;
1462 } else {
1463 buf[rev_pos] = b'0';
1464 }
1465 }
1466
1467 // If we still have the carry bit set, that means that we set
1468 // the whole buffer to '0's and need to increment the integer
1469 // part.
1470 if carry {
1471 // If `integer_part == u64::MAX` and precision < 9, any
1472 // carry of the overflow during rounding of the
1473 // `fractional_part` into the `integer_part` will cause the
1474 // `integer_part` itself to overflow. Avoid this by using an
1475 // `Option<u64>`, with `None` representing `u64::MAX + 1`.
1476 integer_part.checked_add(1)
1477 } else {
1478 Some(integer_part)
1479 }
1480 }
1481 } else {
1482 Some(integer_part)
1483 };
1484
1485 // Determine the end of the buffer: if precision is set, we just
1486 // use as many digits from the buffer (capped to 9). If it isn't
1487 // set, we only use all digits up to the last non-zero one.
1488 let end = f.precision().map(|p| crate::cmp::min(p, 9)).unwrap_or(pos);
1489
1490 // This closure emits the formatted duration without emitting any
1491 // padding (padding is calculated below).
1492 let emit_without_padding = |f: &mut fmt::Formatter<'_>| {
1493 if let Some(integer_part) = integer_part {
1494 write!(f, "{}{}", prefix, integer_part)?;
1495 } else {
1496 // u64::MAX + 1 == 18446744073709551616
1497 write!(f, "{}18446744073709551616", prefix)?;
1498 }
1499
1500 // Write the decimal point and the fractional part (if any).
1501 if end > 0 {
1502 // SAFETY: We are only writing ASCII digits into the buffer and
1503 // it was initialized with '0's, so it contains valid UTF8.
1504 let s = unsafe { crate::str::from_utf8_unchecked(&buf[..end]) };
1505
1506 // If the user request a precision > 9, we pad '0's at the end.
1507 let w = f.precision().unwrap_or(pos);
1508 write!(f, ".{:0<width$}", s, width = w)?;
1509 }
1510
1511 write!(f, "{}", postfix)
1512 };
1513
1514 match f.width() {
1515 None => {
1516 // No `width` specified. There's no need to calculate the
1517 // length of the output in this case, just emit it.
1518 emit_without_padding(f)
1519 }
1520 Some(requested_w) => {
1521 // A `width` was specified. Calculate the actual width of
1522 // the output in order to calculate the required padding.
1523 // It consists of 4 parts:
1524 // 1. The prefix: is either "+" or "", so we can just use len().
1525 // 2. The postfix: can be "µs" so we have to count UTF8 characters.
1526 let mut actual_w = prefix.len() + postfix.chars().count();
1527 // 3. The integer part:
1528 if let Some(integer_part) = integer_part {
1529 if let Some(log) = integer_part.checked_ilog10() {
1530 // integer_part is > 0, so has length log10(x)+1
1531 actual_w += 1 + log as usize;
1532 } else {
1533 // integer_part is 0, so has length 1.
1534 actual_w += 1;
1535 }
1536 } else {
1537 // integer_part is u64::MAX + 1, so has length 20
1538 actual_w += 20;
1539 }
1540 // 4. The fractional part (if any):
1541 if end > 0 {
1542 let frac_part_w = f.precision().unwrap_or(pos);
1543 actual_w += 1 + frac_part_w;
1544 }
1545
1546 if requested_w <= actual_w {
1547 // Output is already longer than `width`, so don't pad.
1548 emit_without_padding(f)
1549 } else {
1550 // We need to add padding. Use the `Formatter::padding` helper function.
1551 let default_align = fmt::Alignment::Left;
1552 let post_padding =
1553 f.padding((requested_w - actual_w) as u16, default_align)?;
1554 emit_without_padding(f)?;
1555 post_padding.write(f)
1556 }
1557 }
1558 }
1559 }
1560
1561 // Print leading '+' sign if requested
1562 let prefix = if f.sign_plus() { "+" } else { "" };
1563
1564 if self.secs > 0 {
1565 fmt_decimal(f, self.secs, self.nanos.as_inner(), NANOS_PER_SEC / 10, prefix, "s")
1566 } else if self.nanos.as_inner() >= NANOS_PER_MILLI {
1567 fmt_decimal(
1568 f,
1569 (self.nanos.as_inner() / NANOS_PER_MILLI) as u64,
1570 self.nanos.as_inner() % NANOS_PER_MILLI,
1571 NANOS_PER_MILLI / 10,
1572 prefix,
1573 "ms",
1574 )
1575 } else if self.nanos.as_inner() >= NANOS_PER_MICRO {
1576 fmt_decimal(
1577 f,
1578 (self.nanos.as_inner() / NANOS_PER_MICRO) as u64,
1579 self.nanos.as_inner() % NANOS_PER_MICRO,
1580 NANOS_PER_MICRO / 10,
1581 prefix,
1582 "µs",
1583 )
1584 } else {
1585 fmt_decimal(f, self.nanos.as_inner() as u64, 0, 1, prefix, "ns")
1586 }
1587 }
1588}
1589
1590/// An error which can be returned when converting a floating-point value of seconds
1591/// into a [`Duration`].
1592///
1593/// This error is used as the error type for [`Duration::try_from_secs_f32`] and
1594/// [`Duration::try_from_secs_f64`].
1595///
1596/// # Example
1597///
1598/// ```
1599/// use std::time::Duration;
1600///
1601/// if let Err(e) = Duration::try_from_secs_f32(-1.0) {
1602/// println!("Failed conversion to Duration: {e}");
1603/// }
1604/// ```
1605#[derive(Debug, Clone, PartialEq, Eq)]
1606#[stable(feature = "duration_checked_float", since = "1.66.0")]
1607pub struct TryFromFloatSecsError {
1608 kind: TryFromFloatSecsErrorKind,
1609}
1610
1611#[stable(feature = "duration_checked_float", since = "1.66.0")]
1612impl fmt::Display for TryFromFloatSecsError {
1613 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1614 match self.kind {
1615 TryFromFloatSecsErrorKind::Negative => {
1616 "cannot convert float seconds to Duration: value is negative"
1617 }
1618 TryFromFloatSecsErrorKind::OverflowOrNan => {
1619 "cannot convert float seconds to Duration: value is either too big or NaN"
1620 }
1621 }
1622 .fmt(f)
1623 }
1624}
1625
1626#[derive(Debug, Clone, PartialEq, Eq)]
1627enum TryFromFloatSecsErrorKind {
1628 // Value is negative.
1629 Negative,
1630 // Value is either too big to be represented as `Duration` or `NaN`.
1631 OverflowOrNan,
1632}
1633
1634macro_rules! try_from_secs {
1635 (
1636 secs = $secs: expr,
1637 mantissa_bits = $mant_bits: literal,
1638 exponent_bits = $exp_bits: literal,
1639 offset = $offset: literal,
1640 bits_ty = $bits_ty:ty,
1641 double_ty = $double_ty:ty,
1642 ) => {{
1643 const MIN_EXP: i16 = 1 - (1i16 << $exp_bits) / 2;
1644 const MANT_MASK: $bits_ty = (1 << $mant_bits) - 1;
1645 const EXP_MASK: $bits_ty = (1 << $exp_bits) - 1;
1646
1647 if $secs < 0.0 {
1648 return Err(TryFromFloatSecsError { kind: TryFromFloatSecsErrorKind::Negative });
1649 }
1650
1651 let bits = $secs.to_bits();
1652 let mant = (bits & MANT_MASK) | (MANT_MASK + 1);
1653 let exp = ((bits >> $mant_bits) & EXP_MASK) as i16 + MIN_EXP;
1654
1655 let (secs, nanos) = if exp < -31 {
1656 // the input represents less than 1ns and can not be rounded to it
1657 (0u64, 0u32)
1658 } else if exp < 0 {
1659 // the input is less than 1 second
1660 let t = <$double_ty>::from(mant) << ($offset + exp);
1661 let nanos_offset = $mant_bits + $offset;
1662 let nanos_tmp = u128::from(NANOS_PER_SEC) * u128::from(t);
1663 let nanos = (nanos_tmp >> nanos_offset) as u32;
1664
1665 let rem_mask = (1 << nanos_offset) - 1;
1666 let rem_msb_mask = 1 << (nanos_offset - 1);
1667 let rem = nanos_tmp & rem_mask;
1668 let is_tie = rem == rem_msb_mask;
1669 let is_even = (nanos & 1) == 0;
1670 let rem_msb = nanos_tmp & rem_msb_mask == 0;
1671 let add_ns = !(rem_msb || (is_even && is_tie));
1672
1673 // f32 does not have enough precision to trigger the second branch
1674 // since it can not represent numbers between 0.999_999_940_395 and 1.0.
1675 let nanos = nanos + add_ns as u32;
1676 if ($mant_bits == 23) || (nanos != NANOS_PER_SEC) { (0, nanos) } else { (1, 0) }
1677 } else if exp < $mant_bits {
1678 let secs = u64::from(mant >> ($mant_bits - exp));
1679 let t = <$double_ty>::from((mant << exp) & MANT_MASK);
1680 let nanos_offset = $mant_bits;
1681 let nanos_tmp = <$double_ty>::from(NANOS_PER_SEC) * t;
1682 let nanos = (nanos_tmp >> nanos_offset) as u32;
1683
1684 let rem_mask = (1 << nanos_offset) - 1;
1685 let rem_msb_mask = 1 << (nanos_offset - 1);
1686 let rem = nanos_tmp & rem_mask;
1687 let is_tie = rem == rem_msb_mask;
1688 let is_even = (nanos & 1) == 0;
1689 let rem_msb = nanos_tmp & rem_msb_mask == 0;
1690 let add_ns = !(rem_msb || (is_even && is_tie));
1691
1692 // f32 does not have enough precision to trigger the second branch.
1693 // For example, it can not represent numbers between 1.999_999_880...
1694 // and 2.0. Bigger values result in even smaller precision of the
1695 // fractional part.
1696 let nanos = nanos + add_ns as u32;
1697 if ($mant_bits == 23) || (nanos != NANOS_PER_SEC) {
1698 (secs, nanos)
1699 } else {
1700 (secs + 1, 0)
1701 }
1702 } else if exp < 64 {
1703 // the input has no fractional part
1704 let secs = u64::from(mant) << (exp - $mant_bits);
1705 (secs, 0)
1706 } else {
1707 return Err(TryFromFloatSecsError { kind: TryFromFloatSecsErrorKind::OverflowOrNan });
1708 };
1709
1710 Ok(Duration::new(secs, nanos))
1711 }};
1712}
1713
1714impl Duration {
1715 /// The checked version of [`from_secs_f32`].
1716 ///
1717 /// [`from_secs_f32`]: Duration::from_secs_f32
1718 ///
1719 /// This constructor will return an `Err` if `secs` is negative, overflows `Duration` or not finite.
1720 ///
1721 /// # Examples
1722 /// ```
1723 /// use std::time::Duration;
1724 ///
1725 /// let res = Duration::try_from_secs_f32(0.0);
1726 /// assert_eq!(res, Ok(Duration::new(0, 0)));
1727 /// let res = Duration::try_from_secs_f32(1e-20);
1728 /// assert_eq!(res, Ok(Duration::new(0, 0)));
1729 /// let res = Duration::try_from_secs_f32(4.2e-7);
1730 /// assert_eq!(res, Ok(Duration::new(0, 420)));
1731 /// let res = Duration::try_from_secs_f32(2.7);
1732 /// assert_eq!(res, Ok(Duration::new(2, 700_000_048)));
1733 /// let res = Duration::try_from_secs_f32(3e10);
1734 /// assert_eq!(res, Ok(Duration::new(30_000_001_024, 0)));
1735 /// // subnormal float:
1736 /// let res = Duration::try_from_secs_f32(f32::from_bits(1));
1737 /// assert_eq!(res, Ok(Duration::new(0, 0)));
1738 ///
1739 /// let res = Duration::try_from_secs_f32(-5.0);
1740 /// assert!(res.is_err());
1741 /// let res = Duration::try_from_secs_f32(f32::NAN);
1742 /// assert!(res.is_err());
1743 /// let res = Duration::try_from_secs_f32(2e19);
1744 /// assert!(res.is_err());
1745 ///
1746 /// // the conversion uses rounding with tie resolution to even
1747 /// let res = Duration::try_from_secs_f32(0.999e-9);
1748 /// assert_eq!(res, Ok(Duration::new(0, 1)));
1749 ///
1750 /// // this float represents exactly 976562.5e-9
1751 /// let val = f32::from_bits(0x3A80_0000);
1752 /// let res = Duration::try_from_secs_f32(val);
1753 /// assert_eq!(res, Ok(Duration::new(0, 976_562)));
1754 ///
1755 /// // this float represents exactly 2929687.5e-9
1756 /// let val = f32::from_bits(0x3B40_0000);
1757 /// let res = Duration::try_from_secs_f32(val);
1758 /// assert_eq!(res, Ok(Duration::new(0, 2_929_688)));
1759 ///
1760 /// // this float represents exactly 1.000_976_562_5
1761 /// let val = f32::from_bits(0x3F802000);
1762 /// let res = Duration::try_from_secs_f32(val);
1763 /// assert_eq!(res, Ok(Duration::new(1, 976_562)));
1764 ///
1765 /// // this float represents exactly 1.002_929_687_5
1766 /// let val = f32::from_bits(0x3F806000);
1767 /// let res = Duration::try_from_secs_f32(val);
1768 /// assert_eq!(res, Ok(Duration::new(1, 2_929_688)));
1769 /// ```
1770 #[stable(feature = "duration_checked_float", since = "1.66.0")]
1771 #[inline]
1772 pub fn try_from_secs_f32(secs: f32) -> Result<Duration, TryFromFloatSecsError> {
1773 try_from_secs!(
1774 secs = secs,
1775 mantissa_bits = 23,
1776 exponent_bits = 8,
1777 offset = 41,
1778 bits_ty = u32,
1779 double_ty = u64,
1780 )
1781 }
1782
1783 /// The checked version of [`from_secs_f64`].
1784 ///
1785 /// [`from_secs_f64`]: Duration::from_secs_f64
1786 ///
1787 /// This constructor will return an `Err` if `secs` is negative, overflows `Duration` or not finite.
1788 ///
1789 /// # Examples
1790 /// ```
1791 /// use std::time::Duration;
1792 ///
1793 /// let res = Duration::try_from_secs_f64(0.0);
1794 /// assert_eq!(res, Ok(Duration::new(0, 0)));
1795 /// let res = Duration::try_from_secs_f64(1e-20);
1796 /// assert_eq!(res, Ok(Duration::new(0, 0)));
1797 /// let res = Duration::try_from_secs_f64(4.2e-7);
1798 /// assert_eq!(res, Ok(Duration::new(0, 420)));
1799 /// let res = Duration::try_from_secs_f64(2.7);
1800 /// assert_eq!(res, Ok(Duration::new(2, 700_000_000)));
1801 /// let res = Duration::try_from_secs_f64(3e10);
1802 /// assert_eq!(res, Ok(Duration::new(30_000_000_000, 0)));
1803 /// // subnormal float
1804 /// let res = Duration::try_from_secs_f64(f64::from_bits(1));
1805 /// assert_eq!(res, Ok(Duration::new(0, 0)));
1806 ///
1807 /// let res = Duration::try_from_secs_f64(-5.0);
1808 /// assert!(res.is_err());
1809 /// let res = Duration::try_from_secs_f64(f64::NAN);
1810 /// assert!(res.is_err());
1811 /// let res = Duration::try_from_secs_f64(2e19);
1812 /// assert!(res.is_err());
1813 ///
1814 /// // the conversion uses rounding with tie resolution to even
1815 /// let res = Duration::try_from_secs_f64(0.999e-9);
1816 /// assert_eq!(res, Ok(Duration::new(0, 1)));
1817 /// let res = Duration::try_from_secs_f64(0.999_999_999_499);
1818 /// assert_eq!(res, Ok(Duration::new(0, 999_999_999)));
1819 /// let res = Duration::try_from_secs_f64(0.999_999_999_501);
1820 /// assert_eq!(res, Ok(Duration::new(1, 0)));
1821 /// let res = Duration::try_from_secs_f64(42.999_999_999_499);
1822 /// assert_eq!(res, Ok(Duration::new(42, 999_999_999)));
1823 /// let res = Duration::try_from_secs_f64(42.999_999_999_501);
1824 /// assert_eq!(res, Ok(Duration::new(43, 0)));
1825 ///
1826 /// // this float represents exactly 976562.5e-9
1827 /// let val = f64::from_bits(0x3F50_0000_0000_0000);
1828 /// let res = Duration::try_from_secs_f64(val);
1829 /// assert_eq!(res, Ok(Duration::new(0, 976_562)));
1830 ///
1831 /// // this float represents exactly 2929687.5e-9
1832 /// let val = f64::from_bits(0x3F68_0000_0000_0000);
1833 /// let res = Duration::try_from_secs_f64(val);
1834 /// assert_eq!(res, Ok(Duration::new(0, 2_929_688)));
1835 ///
1836 /// // this float represents exactly 1.000_976_562_5
1837 /// let val = f64::from_bits(0x3FF0_0400_0000_0000);
1838 /// let res = Duration::try_from_secs_f64(val);
1839 /// assert_eq!(res, Ok(Duration::new(1, 976_562)));
1840 ///
1841 /// // this float represents exactly 1.002_929_687_5
1842 /// let val = f64::from_bits(0x3_FF00_C000_0000_000);
1843 /// let res = Duration::try_from_secs_f64(val);
1844 /// assert_eq!(res, Ok(Duration::new(1, 2_929_688)));
1845 /// ```
1846 #[stable(feature = "duration_checked_float", since = "1.66.0")]
1847 #[inline]
1848 pub fn try_from_secs_f64(secs: f64) -> Result<Duration, TryFromFloatSecsError> {
1849 try_from_secs!(
1850 secs = secs,
1851 mantissa_bits = 52,
1852 exponent_bits = 11,
1853 offset = 44,
1854 bits_ty = u64,
1855 double_ty = u128,
1856 )
1857 }
1858}