src/libcore/time.rs

   1 // Copyright 2012-2017 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10 #![stable(feature = "duration_core", since = "1.25.0")]
  11
  12 //! Temporal quantification.
  13 //!
  14 //! Example:
  15 //!
  16 //! ```
  17 //! use std::time::Duration;
  18 //!
  19 //! let five_seconds = Duration::new(5, 0);
  20 //! // both declarations are equivalent
  21 //! assert_eq!(Duration::new(5, 0), Duration::from_secs(5));
  22 //! ```
  23
  24 use {fmt, u64};
  25 use iter::Sum;
  26 use ops::{Add, Sub, Mul, Div, AddAssign, SubAssign, MulAssign, DivAssign};
  27
  28 const NANOS_PER_SEC: u32 = 1_000_000_000;
  29 const NANOS_PER_MILLI: u32 = 1_000_000;
  30 const NANOS_PER_MICRO: u32 = 1_000;
  31 const MILLIS_PER_SEC: u64 = 1_000;
  32 const MICROS_PER_SEC: u64 = 1_000_000;
  33 const MAX_NANOS_F64: f64 = ((u64::MAX as u128 + 1)*(NANOS_PER_SEC as u128)) as f64;
  34
  35 /// A `Duration` type to represent a span of time, typically used for system
  36 /// timeouts.
  37 ///
  38 /// Each `Duration` is composed of a whole number of seconds and a fractional part
  39 /// represented in nanoseconds.  If the underlying system does not support
  40 /// nanosecond-level precision, APIs binding a system timeout will typically round up
  41 /// the number of nanoseconds.
  42 ///
  43 /// `Duration`s implement many common traits, including [`Add`], [`Sub`], and other
  44 /// [`ops`] traits.
  45 ///
  46 /// [`Add`]: ../../std/ops/trait.Add.html
  47 /// [`Sub`]: ../../std/ops/trait.Sub.html
  48 /// [`ops`]: ../../std/ops/index.html
  49 ///
  50 /// # Examples
  51 ///
  52 /// ```
  53 /// use std::time::Duration;
  54 ///
  55 /// let five_seconds = Duration::new(5, 0);
  56 /// let five_seconds_and_five_nanos = five_seconds + Duration::new(0, 5);
  57 ///
  58 /// assert_eq!(five_seconds_and_five_nanos.as_secs(), 5);
  59 /// assert_eq!(five_seconds_and_five_nanos.subsec_nanos(), 5);
  60 ///
  61 /// let ten_millis = Duration::from_millis(10);
  62 /// ```
  63 #[stable(feature = "duration", since = "1.3.0")]
  64 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
  65 pub struct Duration {
  66     secs: u64,
  67     nanos: u32, // Always 0 <= nanos < NANOS_PER_SEC
  68 }
  69
  70 impl Duration {
  71     /// Creates a new `Duration` from the specified number of whole seconds and
  72     /// additional nanoseconds.
  73     ///
  74     /// If the number of nanoseconds is greater than 1 billion (the number of
  75     /// nanoseconds in a second), then it will carry over into the seconds provided.
  76     ///
  77     /// # Panics
  78     ///
  79     /// This constructor will panic if the carry from the nanoseconds overflows
  80     /// the seconds counter.
  81     ///
  82     /// # Examples
  83     ///
  84     /// ```
  85     /// use std::time::Duration;
  86     ///
  87     /// let five_seconds = Duration::new(5, 0);
  88     /// ```
  89     #[stable(feature = "duration", since = "1.3.0")]
  90     #[inline]
  91     pub fn new(secs: u64, nanos: u32) -> Duration {
  92         let secs = secs.checked_add((nanos / NANOS_PER_SEC) as u64)
  93             .expect("overflow in Duration::new");
  94         let nanos = nanos % NANOS_PER_SEC;
  95         Duration { secs, nanos }
  96     }
  97
  98     /// Creates a new `Duration` from the specified number of whole seconds.
  99     ///
 100     /// # Examples
 101     ///
 102     /// ```
 103     /// use std::time::Duration;
 104     ///
 105     /// let duration = Duration::from_secs(5);
 106     ///
 107     /// assert_eq!(5, duration.as_secs());
 108     /// assert_eq!(0, duration.subsec_nanos());
 109     /// ```
 110     #[stable(feature = "duration", since = "1.3.0")]
 111     #[inline]
 112     #[rustc_promotable]
 113     pub const fn from_secs(secs: u64) -> Duration {
 114         Duration { secs, nanos: 0 }
 115     }
 116
 117     /// Creates a new `Duration` from the specified number of milliseconds.
 118     ///
 119     /// # Examples
 120     ///
 121     /// ```
 122     /// use std::time::Duration;
 123     ///
 124     /// let duration = Duration::from_millis(2569);
 125     ///
 126     /// assert_eq!(2, duration.as_secs());
 127     /// assert_eq!(569_000_000, duration.subsec_nanos());
 128     /// ```
 129     #[stable(feature = "duration", since = "1.3.0")]
 130     #[inline]
 131     #[rustc_promotable]
 132     pub const fn from_millis(millis: u64) -> Duration {
 133         Duration {
 134             secs: millis / MILLIS_PER_SEC,
 135             nanos: ((millis % MILLIS_PER_SEC) as u32) * NANOS_PER_MILLI,
 136         }
 137     }
 138
 139     /// Creates a new `Duration` from the specified number of microseconds.
 140     ///
 141     /// # Examples
 142     ///
 143     /// ```
 144     /// use std::time::Duration;
 145     ///
 146     /// let duration = Duration::from_micros(1_000_002);
 147     ///
 148     /// assert_eq!(1, duration.as_secs());
 149     /// assert_eq!(2000, duration.subsec_nanos());
 150     /// ```
 151     #[stable(feature = "duration_from_micros", since = "1.27.0")]
 152     #[inline]
 153     #[rustc_promotable]
 154     pub const fn from_micros(micros: u64) -> Duration {
 155         Duration {
 156             secs: micros / MICROS_PER_SEC,
 157             nanos: ((micros % MICROS_PER_SEC) as u32) * NANOS_PER_MICRO,
 158         }
 159     }
 160
 161     /// Creates a new `Duration` from the specified number of nanoseconds.
 162     ///
 163     /// # Examples
 164     ///
 165     /// ```
 166     /// use std::time::Duration;
 167     ///
 168     /// let duration = Duration::from_nanos(1_000_000_123);
 169     ///
 170     /// assert_eq!(1, duration.as_secs());
 171     /// assert_eq!(123, duration.subsec_nanos());
 172     /// ```
 173     #[stable(feature = "duration_extras", since = "1.27.0")]
 174     #[inline]
 175     #[rustc_promotable]
 176     pub const fn from_nanos(nanos: u64) -> Duration {
 177         Duration {
 178             secs: nanos / (NANOS_PER_SEC as u64),
 179             nanos: (nanos % (NANOS_PER_SEC as u64)) as u32,
 180         }
 181     }
 182
 183     /// Returns the number of _whole_ seconds contained by this `Duration`.
 184     ///
 185     /// The returned value does not include the fractional (nanosecond) part of the
 186     /// duration, which can be obtained using [`subsec_nanos`].
 187     ///
 188     /// # Examples
 189     ///
 190     /// ```
 191     /// use std::time::Duration;
 192     ///
 193     /// let duration = Duration::new(5, 730023852);
 194     /// assert_eq!(duration.as_secs(), 5);
 195     /// ```
 196     ///
 197     /// To determine the total number of seconds represented by the `Duration`,
 198     /// use `as_secs` in combination with [`subsec_nanos`]:
 199     ///
 200     /// ```
 201     /// use std::time::Duration;
 202     ///
 203     /// let duration = Duration::new(5, 730023852);
 204     ///
 205     /// assert_eq!(5.730023852,
 206     ///            duration.as_secs() as f64
 207     ///            + duration.subsec_nanos() as f64 * 1e-9);
 208     /// ```
 209     ///
 210     /// [`subsec_nanos`]: #method.subsec_nanos
 211     #[stable(feature = "duration", since = "1.3.0")]
 212     #[inline]
 213     pub const fn as_secs(&self) -> u64 { self.secs }
 214
 215     /// Returns the fractional part of this `Duration`, in whole milliseconds.
 216     ///
 217     /// This method does **not** return the length of the duration when
 218     /// represented by milliseconds. The returned number always represents a
 219     /// fractional portion of a second (i.e. it is less than one thousand).
 220     ///
 221     /// # Examples
 222     ///
 223     /// ```
 224     /// use std::time::Duration;
 225     ///
 226     /// let duration = Duration::from_millis(5432);
 227     /// assert_eq!(duration.as_secs(), 5);
 228     /// assert_eq!(duration.subsec_millis(), 432);
 229     /// ```
 230     #[stable(feature = "duration_extras", since = "1.27.0")]
 231     #[inline]
 232     pub const fn subsec_millis(&self) -> u32 { self.nanos / NANOS_PER_MILLI }
 233
 234     /// Returns the fractional part of this `Duration`, in whole microseconds.
 235     ///
 236     /// This method does **not** return the length of the duration when
 237     /// represented by microseconds. The returned number always represents a
 238     /// fractional portion of a second (i.e. it is less than one million).
 239     ///
 240     /// # Examples
 241     ///
 242     /// ```
 243     /// use std::time::Duration;
 244     ///
 245     /// let duration = Duration::from_micros(1_234_567);
 246     /// assert_eq!(duration.as_secs(), 1);
 247     /// assert_eq!(duration.subsec_micros(), 234_567);
 248     /// ```
 249     #[stable(feature = "duration_extras", since = "1.27.0")]
 250     #[inline]
 251     pub const fn subsec_micros(&self) -> u32 { self.nanos / NANOS_PER_MICRO }
 252
 253     /// Returns the fractional part of this `Duration`, in nanoseconds.
 254     ///
 255     /// This method does **not** return the length of the duration when
 256     /// represented by nanoseconds. The returned number always represents a
 257     /// fractional portion of a second (i.e. it is less than one billion).
 258     ///
 259     /// # Examples
 260     ///
 261     /// ```
 262     /// use std::time::Duration;
 263     ///
 264     /// let duration = Duration::from_millis(5010);
 265     /// assert_eq!(duration.as_secs(), 5);
 266     /// assert_eq!(duration.subsec_nanos(), 10_000_000);
 267     /// ```
 268     #[stable(feature = "duration", since = "1.3.0")]
 269     #[inline]
 270     pub const fn subsec_nanos(&self) -> u32 { self.nanos }
 271
 272     /// Returns the total number of whole milliseconds contained by this `Duration`.
 273     ///
 274     /// # Examples
 275     ///
 276     /// ```
 277     /// # #![feature(duration_as_u128)]
 278     /// use std::time::Duration;
 279     ///
 280     /// let duration = Duration::new(5, 730023852);
 281     /// assert_eq!(duration.as_millis(), 5730);
 282     /// ```
 283     #[unstable(feature = "duration_as_u128", issue = "50202")]
 284     #[inline]
 285     pub const fn as_millis(&self) -> u128 {
 286         self.secs as u128 * MILLIS_PER_SEC as u128 + (self.nanos / NANOS_PER_MILLI) as u128
 287     }
 288
 289     /// Returns the total number of whole microseconds contained by this `Duration`.
 290     ///
 291     /// # Examples
 292     ///
 293     /// ```
 294     /// # #![feature(duration_as_u128)]
 295     /// use std::time::Duration;
 296     ///
 297     /// let duration = Duration::new(5, 730023852);
 298     /// assert_eq!(duration.as_micros(), 5730023);
 299     /// ```
 300     #[unstable(feature = "duration_as_u128", issue = "50202")]
 301     #[inline]
 302     pub const fn as_micros(&self) -> u128 {
 303         self.secs as u128 * MICROS_PER_SEC as u128 + (self.nanos / NANOS_PER_MICRO) as u128
 304     }
 305
 306     /// Returns the total number of nanoseconds contained by this `Duration`.
 307     ///
 308     /// # Examples
 309     ///
 310     /// ```
 311     /// # #![feature(duration_as_u128)]
 312     /// use std::time::Duration;
 313     ///
 314     /// let duration = Duration::new(5, 730023852);
 315     /// assert_eq!(duration.as_nanos(), 5730023852);
 316     /// ```
 317     #[unstable(feature = "duration_as_u128", issue = "50202")]
 318     #[inline]
 319     pub const fn as_nanos(&self) -> u128 {
 320         self.secs as u128 * NANOS_PER_SEC as u128 + self.nanos as u128
 321     }
 322
 323     /// Checked `Duration` addition. Computes `self + other`, returning [`None`]
 324     /// if overflow occurred.
 325     ///
 326     /// [`None`]: ../../std/option/enum.Option.html#variant.None
 327     ///
 328     /// # Examples
 329     ///
 330     /// Basic usage:
 331     ///
 332     /// ```
 333     /// use std::time::Duration;
 334     ///
 335     /// assert_eq!(Duration::new(0, 0).checked_add(Duration::new(0, 1)), Some(Duration::new(0, 1)));
 336     /// assert_eq!(Duration::new(1, 0).checked_add(Duration::new(std::u64::MAX, 0)), None);
 337     /// ```
 338     #[stable(feature = "duration_checked_ops", since = "1.16.0")]
 339     #[inline]
 340     pub fn checked_add(self, rhs: Duration) -> Option<Duration> {
 341         if let Some(mut secs) = self.secs.checked_add(rhs.secs) {
 342             let mut nanos = self.nanos + rhs.nanos;
 343             if nanos >= NANOS_PER_SEC {
 344                 nanos -= NANOS_PER_SEC;
 345                 if let Some(new_secs) = secs.checked_add(1) {
 346                     secs = new_secs;
 347                 } else {
 348                     return None;
 349                 }
 350             }
 351             debug_assert!(nanos < NANOS_PER_SEC);
 352             Some(Duration {
 353                 secs,
 354                 nanos,
 355             })
 356         } else {
 357             None
 358         }
 359     }
 360
 361     /// Checked `Duration` subtraction. Computes `self - other`, returning [`None`]
 362     /// if the result would be negative or if overflow occurred.
 363     ///
 364     /// [`None`]: ../../std/option/enum.Option.html#variant.None
 365     ///
 366     /// # Examples
 367     ///
 368     /// Basic usage:
 369     ///
 370     /// ```
 371     /// use std::time::Duration;
 372     ///
 373     /// assert_eq!(Duration::new(0, 1).checked_sub(Duration::new(0, 0)), Some(Duration::new(0, 1)));
 374     /// assert_eq!(Duration::new(0, 0).checked_sub(Duration::new(0, 1)), None);
 375     /// ```
 376     #[stable(feature = "duration_checked_ops", since = "1.16.0")]
 377     #[inline]
 378     pub fn checked_sub(self, rhs: Duration) -> Option<Duration> {
 379         if let Some(mut secs) = self.secs.checked_sub(rhs.secs) {
 380             let nanos = if self.nanos >= rhs.nanos {
 381                 self.nanos - rhs.nanos
 382             } else {
 383                 if let Some(sub_secs) = secs.checked_sub(1) {
 384                     secs = sub_secs;
 385                     self.nanos + NANOS_PER_SEC - rhs.nanos
 386                 } else {
 387                     return None;
 388                 }
 389             };
 390             debug_assert!(nanos < NANOS_PER_SEC);
 391             Some(Duration { secs, nanos })
 392         } else {
 393             None
 394         }
 395     }
 396
 397     /// Checked `Duration` multiplication. Computes `self * other`, returning
 398     /// [`None`] if overflow occurred.
 399     ///
 400     /// [`None`]: ../../std/option/enum.Option.html#variant.None
 401     ///
 402     /// # Examples
 403     ///
 404     /// Basic usage:
 405     ///
 406     /// ```
 407     /// use std::time::Duration;
 408     ///
 409     /// assert_eq!(Duration::new(0, 500_000_001).checked_mul(2), Some(Duration::new(1, 2)));
 410     /// assert_eq!(Duration::new(std::u64::MAX - 1, 0).checked_mul(2), None);
 411     /// ```
 412     #[stable(feature = "duration_checked_ops", since = "1.16.0")]
 413     #[inline]
 414     pub fn checked_mul(self, rhs: u32) -> Option<Duration> {
 415         // Multiply nanoseconds as u64, because it cannot overflow that way.
 416         let total_nanos = self.nanos as u64 * rhs as u64;
 417         let extra_secs = total_nanos / (NANOS_PER_SEC as u64);
 418         let nanos = (total_nanos % (NANOS_PER_SEC as u64)) as u32;
 419         if let Some(secs) = self.secs
 420             .checked_mul(rhs as u64)
 421             .and_then(|s| s.checked_add(extra_secs)) {
 422             debug_assert!(nanos < NANOS_PER_SEC);
 423             Some(Duration {
 424                 secs,
 425                 nanos,
 426             })
 427         } else {
 428             None
 429         }
 430     }
 431
 432     /// Checked `Duration` division. Computes `self / other`, returning [`None`]
 433     /// if `other == 0`.
 434     ///
 435     /// [`None`]: ../../std/option/enum.Option.html#variant.None
 436     ///
 437     /// # Examples
 438     ///
 439     /// Basic usage:
 440     ///
 441     /// ```
 442     /// use std::time::Duration;
 443     ///
 444     /// assert_eq!(Duration::new(2, 0).checked_div(2), Some(Duration::new(1, 0)));
 445     /// assert_eq!(Duration::new(1, 0).checked_div(2), Some(Duration::new(0, 500_000_000)));
 446     /// assert_eq!(Duration::new(2, 0).checked_div(0), None);
 447     /// ```
 448     #[stable(feature = "duration_checked_ops", since = "1.16.0")]
 449     #[inline]
 450     pub fn checked_div(self, rhs: u32) -> Option<Duration> {
 451         if rhs != 0 {
 452             let secs = self.secs / (rhs as u64);
 453             let carry = self.secs - secs * (rhs as u64);
 454             let extra_nanos = carry * (NANOS_PER_SEC as u64) / (rhs as u64);
 455             let nanos = self.nanos / rhs + (extra_nanos as u32);
 456             debug_assert!(nanos < NANOS_PER_SEC);
 457             Some(Duration { secs, nanos })
 458         } else {
 459             None
 460         }
 461     }
 462
 463     /// Returns the number of seconds contained by this `Duration` as `f64`.
 464     ///
 465     /// The returned value does include the fractional (nanosecond) part of the duration.
 466     ///
 467     /// # Examples
 468     /// ```
 469     /// #![feature(duration_float)]
 470     /// use std::time::Duration;
 471     ///
 472     /// let dur = Duration::new(2, 700_000_000);
 473     /// assert_eq!(dur.as_float_secs(), 2.7);
 474     /// ```
 475     #[unstable(feature = "duration_float", issue = "54361")]
 476     #[inline]
 477     pub const fn as_float_secs(&self) -> f64 {
 478         (self.secs as f64) + (self.nanos as f64) / (NANOS_PER_SEC as f64)
 479     }
 480
 481     /// Creates a new `Duration` from the specified number of seconds.
 482     ///
 483     /// # Panics
 484     /// This constructor will panic if `secs` is not finite, negative or overflows `Duration`.
 485     ///
 486     /// # Examples
 487     /// ```
 488     /// #![feature(duration_float)]
 489     /// use std::time::Duration;
 490     ///
 491     /// let dur = Duration::from_float_secs(2.7);
 492     /// assert_eq!(dur, Duration::new(2, 700_000_000));
 493     /// ```
 494     #[unstable(feature = "duration_float", issue = "54361")]
 495     #[inline]
 496     pub fn from_float_secs(secs: f64) -> Duration {
 497         let nanos =  secs * (NANOS_PER_SEC as f64);
 498         if !nanos.is_finite() {
 499             panic!("got non-finite value when converting float to duration");
 500         }
 501         if nanos >= MAX_NANOS_F64 {
 502             panic!("overflow when converting float to duration");
 503         }
 504         if nanos < 0.0 {
 505             panic!("underflow when converting float to duration");
 506         }
 507         let nanos =  nanos as u128;
 508         Duration {
 509             secs: (nanos / (NANOS_PER_SEC as u128)) as u64,
 510             nanos: (nanos % (NANOS_PER_SEC as u128)) as u32,
 511         }
 512     }
 513
 514     /// Multiply `Duration` by `f64`.
 515     ///
 516     /// # Panics
 517     /// This method will panic if result is not finite, negative or overflows `Duration`.
 518     ///
 519     /// # Examples
 520     /// ```
 521     /// #![feature(duration_float)]
 522     /// use std::time::Duration;
 523     ///
 524     /// let dur = Duration::new(2, 700_000_000);
 525     /// assert_eq!(dur.mul_f64(3.14), Duration::new(8, 478_000_000));
 526     /// assert_eq!(dur.mul_f64(3.14e5), Duration::new(847_800, 0));
 527     /// ```
 528     #[unstable(feature = "duration_float", issue = "54361")]
 529     #[inline]
 530     pub fn mul_f64(self, rhs: f64) -> Duration {
 531         Duration::from_float_secs(rhs * self.as_float_secs())
 532     }
 533
 534     /// Divide `Duration` by `f64`.
 535     ///
 536     /// # Panics
 537     /// This method will panic if result is not finite, negative or overflows `Duration`.
 538     ///
 539     /// # Examples
 540     /// ```
 541     /// #![feature(duration_float)]
 542     /// use std::time::Duration;
 543     ///
 544     /// let dur = Duration::new(2, 700_000_000);
 545     /// assert_eq!(dur.div_f64(3.14), Duration::new(0, 859_872_611));
 546     /// // note that truncation is used, not rounding
 547     /// assert_eq!(dur.div_f64(3.14e5), Duration::new(0, 8_598));
 548     /// ```
 549     #[unstable(feature = "duration_float", issue = "54361")]
 550     #[inline]
 551     pub fn div_f64(self, rhs: f64) -> Duration {
 552         Duration::from_float_secs(self.as_float_secs() / rhs)
 553     }
 554
 555     /// Divide `Duration` by `Duration` and return `f64`.
 556     ///
 557     /// # Examples
 558     /// ```
 559     /// #![feature(duration_float)]
 560     /// use std::time::Duration;
 561     ///
 562     /// let dur1 = Duration::new(2, 700_000_000);
 563     /// let dur2 = Duration::new(5, 400_000_000);
 564     /// assert_eq!(dur1.div_duration(dur2), 0.5);
 565     /// ```
 566     #[unstable(feature = "duration_float", issue = "54361")]
 567     #[inline]
 568     pub fn div_duration(self, rhs: Duration) -> f64 {
 569         self.as_float_secs() / rhs.as_float_secs()
 570     }
 571 }
 572
 573 #[stable(feature = "duration", since = "1.3.0")]
 574 impl Add for Duration {
 575     type Output = Duration;
 576
 577     fn add(self, rhs: Duration) -> Duration {
 578         self.checked_add(rhs).expect("overflow when adding durations")
 579     }
 580 }
 581
 582 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
 583 impl AddAssign for Duration {
 584     fn add_assign(&mut self, rhs: Duration) {
 585         *self = *self + rhs;
 586     }
 587 }
 588
 589 #[stable(feature = "duration", since = "1.3.0")]
 590 impl Sub for Duration {
 591     type Output = Duration;
 592
 593     fn sub(self, rhs: Duration) -> Duration {
 594         self.checked_sub(rhs).expect("overflow when subtracting durations")
 595     }
 596 }
 597
 598 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
 599 impl SubAssign for Duration {
 600     fn sub_assign(&mut self, rhs: Duration) {
 601         *self = *self - rhs;
 602     }
 603 }
 604
 605 #[stable(feature = "duration", since = "1.3.0")]
 606 impl Mul<u32> for Duration {
 607     type Output = Duration;
 608
 609     fn mul(self, rhs: u32) -> Duration {
 610         self.checked_mul(rhs).expect("overflow when multiplying duration by scalar")
 611     }
 612 }
 613
 614 #[stable(feature = "symmetric_u32_duration_mul", since = "1.31.0")]
 615 impl Mul<Duration> for u32 {
 616     type Output = Duration;
 617
 618     fn mul(self, rhs: Duration) -> Duration {
 619         rhs * self
 620     }
 621 }
 622
 623 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
 624 impl MulAssign<u32> for Duration {
 625     fn mul_assign(&mut self, rhs: u32) {
 626         *self = *self * rhs;
 627     }
 628 }
 629
 630 #[stable(feature = "duration", since = "1.3.0")]
 631 impl Div<u32> for Duration {
 632     type Output = Duration;
 633
 634     fn div(self, rhs: u32) -> Duration {
 635         self.checked_div(rhs).expect("divide by zero error when dividing duration by scalar")
 636     }
 637 }
 638
 639 #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
 640 impl DivAssign<u32> for Duration {
 641     fn div_assign(&mut self, rhs: u32) {
 642         *self = *self / rhs;
 643     }
 644 }
 645
 646 macro_rules! sum_durations {
 647     ($iter:expr) => {{
 648         let mut total_secs: u64 = 0;
 649         let mut total_nanos: u64 = 0;
 650
 651         for entry in $iter {
 652             total_secs = total_secs
 653                 .checked_add(entry.secs)
 654                 .expect("overflow in iter::sum over durations");
 655             total_nanos = match total_nanos.checked_add(entry.nanos as u64) {
 656                 Some(n) => n,
 657                 None => {
 658                     total_secs = total_secs
 659                         .checked_add(total_nanos / NANOS_PER_SEC as u64)
 660                         .expect("overflow in iter::sum over durations");
 661                     (total_nanos % NANOS_PER_SEC as u64) + entry.nanos as u64
 662                 }
 663             };
 664         }
 665         total_secs = total_secs
 666             .checked_add(total_nanos / NANOS_PER_SEC as u64)
 667             .expect("overflow in iter::sum over durations");
 668         total_nanos = total_nanos % NANOS_PER_SEC as u64;
 669         Duration {
 670             secs: total_secs,
 671             nanos: total_nanos as u32,
 672         }
 673     }};
 674 }
 675
 676 #[stable(feature = "duration_sum", since = "1.16.0")]
 677 impl Sum for Duration {
 678     fn sum<I: Iterator<Item=Duration>>(iter: I) -> Duration {
 679         sum_durations!(iter)
 680     }
 681 }
 682
 683 #[stable(feature = "duration_sum", since = "1.16.0")]
 684 impl<'a> Sum<&'a Duration> for Duration {
 685     fn sum<I: Iterator<Item=&'a Duration>>(iter: I) -> Duration {
 686         sum_durations!(iter)
 687     }
 688 }
 689
 690 #[stable(feature = "duration_debug_impl", since = "1.27.0")]
 691 impl fmt::Debug for Duration {
 692     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 693         /// Formats a floating point number in decimal notation.
 694         ///
 695         /// The number is given as the `integer_part` and a fractional part.
 696         /// The value of the fractional part is `fractional_part / divisor`. So
 697         /// `integer_part` = 3, `fractional_part` = 12 and `divisor` = 100
 698         /// represents the number `3.012`. Trailing zeros are omitted.
 699         ///
 700         /// `divisor` must not be above 100_000_000. It also should be a power
 701         /// of 10, everything else doesn't make sense. `fractional_part` has
 702         /// to be less than `10 * divisor`!
 703         fn fmt_decimal(
 704             f: &mut fmt::Formatter,
 705             mut integer_part: u64,
 706             mut fractional_part: u32,
 707             mut divisor: u32,
 708         ) -> fmt::Result {
 709             // Encode the fractional part into a temporary buffer. The buffer
 710             // only need to hold 9 elements, because `fractional_part` has to
 711             // be smaller than 10^9. The buffer is prefilled with '0' digits
 712             // to simplify the code below.
 713             let mut buf = [b'0'; 9];
 714
 715             // The next digit is written at this position
 716             let mut pos = 0;
 717
 718             // We keep writing digits into the buffer while there are non-zero
 719             // digits left and we haven't written enough digits yet.
 720             while fractional_part > 0 && pos < f.precision().unwrap_or(9) {
 721                 // Write new digit into the buffer
 722                 buf[pos] = b'0' + (fractional_part / divisor) as u8;
 723
 724                 fractional_part %= divisor;
 725                 divisor /= 10;
 726                 pos += 1;
 727             }
 728
 729             // If a precision < 9 was specified, there may be some non-zero
 730             // digits left that weren't written into the buffer. In that case we
 731             // need to perform rounding to match the semantics of printing
 732             // normal floating point numbers. However, we only need to do work
 733             // when rounding up. This happens if the first digit of the
 734             // remaining ones is >= 5.
 735             if fractional_part > 0 && fractional_part >= divisor * 5 {
 736                 // Round up the number contained in the buffer. We go through
 737                 // the buffer backwards and keep track of the carry.
 738                 let mut rev_pos = pos;
 739                 let mut carry = true;
 740                 while carry && rev_pos > 0 {
 741                     rev_pos -= 1;
 742
 743                     // If the digit in the buffer is not '9', we just need to
 744                     // increment it and can stop then (since we don't have a
 745                     // carry anymore). Otherwise, we set it to '0' (overflow)
 746                     // and continue.
 747                     if buf[rev_pos] < b'9' {
 748                         buf[rev_pos] += 1;
 749                         carry = false;
 750                     } else {
 751                         buf[rev_pos] = b'0';
 752                     }
 753                 }
 754
 755                 // If we still have the carry bit set, that means that we set
 756                 // the whole buffer to '0's and need to increment the integer
 757                 // part.
 758                 if carry {
 759                     integer_part += 1;
 760                 }
 761             }
 762
 763             // Determine the end of the buffer: if precision is set, we just
 764             // use as many digits from the buffer (capped to 9). If it isn't
 765             // set, we only use all digits up to the last non-zero one.
 766             let end = f.precision().map(|p| ::cmp::min(p, 9)).unwrap_or(pos);
 767
 768             // If we haven't emitted a single fractional digit and the precision
 769             // wasn't set to a non-zero value, we don't print the decimal point.
 770             if end == 0 {
 771                 write!(f, "{}", integer_part)
 772             } else {
 773                 // We are only writing ASCII digits into the buffer and it was
 774                 // initialized with '0's, so it contains valid UTF8.
 775                 let s = unsafe {
 776                     ::str::from_utf8_unchecked(&buf[..end])
 777                 };
 778
 779                 // If the user request a precision > 9, we pad '0's at the end.
 780                 let w = f.precision().unwrap_or(pos);
 781                 write!(f, "{}.{:0<width$}", integer_part, s, width = w)
 782             }
 783         }
 784
 785         // Print leading '+' sign if requested
 786         if f.sign_plus() {
 787             write!(f, "+")?;
 788         }
 789
 790         if self.secs > 0 {
 791             fmt_decimal(f, self.secs, self.nanos, 100_000_000)?;
 792             f.write_str("s")
 793         } else if self.nanos >= 1_000_000 {
 794             fmt_decimal(f, self.nanos as u64 / 1_000_000, self.nanos % 1_000_000, 100_000)?;
 795             f.write_str("ms")
 796         } else if self.nanos >= 1_000 {
 797             fmt_decimal(f, self.nanos as u64 / 1_000, self.nanos % 1_000, 100)?;
 798             f.write_str("µs")
 799         } else {
 800             fmt_decimal(f, self.nanos as u64, 0, 1)?;
 801             f.write_str("ns")
 802         }
 803     }
 804 }