duration.rs.html -- source
Description: Source to the Rust file `src/libstd/time/duration.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420

    // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    use ops::{Add, Sub, Mul, Div, AddAssign, SubAssign, MulAssign, DivAssign};

    const NANOS_PER_SEC: u32 = 1_000_000_000;
    const NANOS_PER_MILLI: u32 = 1_000_000;
    const MILLIS_PER_SEC: u64 = 1_000;

    /// A duration type to represent a span of time, typically used for system
    /// timeouts.
    ///
    /// Each duration is composed of a number of seconds and nanosecond precision.
    /// APIs binding a system timeout will typically round up the nanosecond
    /// precision if the underlying system does not support that level of precision.
    ///
    /// Durations implement many common traits, including `Add`, `Sub`, and other
    /// ops traits. Currently a duration may only be inspected for its number of
    /// seconds and its nanosecond precision.
    ///
    /// # Examples
    ///
    /// ```
    /// use std::time::Duration;
    ///
    /// let five_seconds = Duration::new(5, 0);
    /// let five_seconds_and_five_nanos = five_seconds + Duration::new(0, 5);
    ///
    /// assert_eq!(five_seconds_and_five_nanos.as_secs(), 5);
    /// assert_eq!(five_seconds_and_five_nanos.subsec_nanos(), 5);
    ///
    /// let ten_millis = Duration::from_millis(10);
    /// ```
    #[stable(feature = "duration", since = "1.3.0")]
    #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
    pub struct Duration {
        secs: u64,
        nanos: u32, // Always 0 <= nanos < NANOS_PER_SEC
    }

    impl Duration {
        /// Creates a new `Duration` from the specified number of seconds and
        /// additional nanosecond precision.
        ///
        /// If the nanoseconds is greater than 1 billion (the number of nanoseconds
        /// in a second), then it will carry over into the seconds provided.
        ///
        /// # Panics
        ///
        /// This constructor will panic if the carry from the nanoseconds overflows
        /// the seconds counter.
        #[stable(feature = "duration", since = "1.3.0")]
        #[inline]
        pub fn new(secs: u64, nanos: u32) -> Duration {
            let secs = secs.checked_add((nanos / NANOS_PER_SEC) as u64)
                .expect("overflow in Duration::new");
            let nanos = nanos % NANOS_PER_SEC;
            Duration { secs: secs, nanos: nanos }
        }

        /// Creates a new `Duration` from the specified number of seconds.
        #[stable(feature = "duration", since = "1.3.0")]
        #[inline]
        pub fn from_secs(secs: u64) -> Duration {
            Duration { secs: secs, nanos: 0 }
        }

        /// Creates a new `Duration` from the specified number of milliseconds.
        #[stable(feature = "duration", since = "1.3.0")]
        #[inline]
        pub fn from_millis(millis: u64) -> Duration {
            let secs = millis / MILLIS_PER_SEC;
            let nanos = ((millis % MILLIS_PER_SEC) as u32) * NANOS_PER_MILLI;
            Duration { secs: secs, nanos: nanos }
        }

        /// Returns the number of whole seconds represented by this duration.
        ///
        /// The extra precision represented by this duration is ignored (i.e. extra
        /// nanoseconds are not represented in the returned value).
        #[stable(feature = "duration", since = "1.3.0")]
        #[inline]
        pub fn as_secs(&self) -> u64 { self.secs }

        /// Returns the nanosecond precision represented by this duration.
        ///
        /// This method does **not** return the length of the duration when
        /// represented by nanoseconds. The returned number always represents a
        /// fractional portion of a second (i.e. it is less than one billion).
        #[stable(feature = "duration", since = "1.3.0")]
        #[inline]
        pub fn subsec_nanos(&self) -> u32 { self.nanos }

        /// Checked duration addition. Computes `self + other`, returning `None`
        /// if overflow occurred.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        /// #![feature(duration_checked_ops)]
        ///
        /// use std::time::Duration;
        ///
        /// assert_eq!(Duration::new(0, 0).checked_add(Duration::new(0, 1)), Some(Duration::new(0, 1)));
        /// assert_eq!(Duration::new(1, 0).checked_add(Duration::new(std::u64::MAX, 0)), None);
        /// ```
        #[unstable(feature = "duration_checked_ops", issue = "35774")]
        #[inline]
        pub fn checked_add(self, rhs: Duration) -> Option<Duration> {
            if let Some(mut secs) = self.secs.checked_add(rhs.secs) {
                let mut nanos = self.nanos + rhs.nanos;
                if nanos >= NANOS_PER_SEC {
                    nanos -= NANOS_PER_SEC;
                    if let Some(new_secs) = secs.checked_add(1) {
                        secs = new_secs;
                    } else {
                        return None;
                    }
                }
                debug_assert!(nanos < NANOS_PER_SEC);
                Some(Duration {
                    secs: secs,
                    nanos: nanos,
                })
            } else {
                None
            }
        }

        /// Checked duration subtraction. Computes `self + other`, returning `None`
        /// if the result would be negative or if underflow occurred.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        /// #![feature(duration_checked_ops)]
        ///
        /// use std::time::Duration;
        ///
        /// assert_eq!(Duration::new(0, 1).checked_sub(Duration::new(0, 0)), Some(Duration::new(0, 1)));
        /// assert_eq!(Duration::new(0, 0).checked_sub(Duration::new(0, 1)), None);
        /// ```
        #[unstable(feature = "duration_checked_ops", issue = "35774")]
        #[inline]
        pub fn checked_sub(self, rhs: Duration) -> Option<Duration> {
            if let Some(mut secs) = self.secs.checked_sub(rhs.secs) {
                let nanos = if self.nanos >= rhs.nanos {
                    self.nanos - rhs.nanos
                } else {
                    if let Some(sub_secs) = secs.checked_sub(1) {
                        secs = sub_secs;
                        self.nanos + NANOS_PER_SEC - rhs.nanos
                    } else {
                        return None;
                    }
                };
                debug_assert!(nanos < NANOS_PER_SEC);
                Some(Duration { secs: secs, nanos: nanos })
            } else {
                None
            }
        }

        /// Checked duration multiplication. Computes `self * other`, returning
        /// `None` if underflow or overflow occurred.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        /// #![feature(duration_checked_ops)]
        ///
        /// use std::time::Duration;
        ///
        /// assert_eq!(Duration::new(0, 500_000_001).checked_mul(2), Some(Duration::new(1, 2)));
        /// assert_eq!(Duration::new(std::u64::MAX - 1, 0).checked_mul(2), None);
        /// ```
        #[unstable(feature = "duration_checked_ops", issue = "35774")]
        #[inline]
        pub fn checked_mul(self, rhs: u32) -> Option<Duration> {
            // Multiply nanoseconds as u64, because it cannot overflow that way.
            let total_nanos = self.nanos as u64 * rhs as u64;
            let extra_secs = total_nanos / (NANOS_PER_SEC as u64);
            let nanos = (total_nanos % (NANOS_PER_SEC as u64)) as u32;
            if let Some(secs) = self.secs
                .checked_mul(rhs as u64)
                .and_then(|s| s.checked_add(extra_secs)) {
                debug_assert!(nanos < NANOS_PER_SEC);
                Some(Duration {
                    secs: secs,
                    nanos: nanos,
                })
            } else {
                None
            }
        }

        /// Checked duration division. Computes `self / other`, returning `None`
        /// if `other == 0` or the operation results in underflow or overflow.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        /// #![feature(duration_checked_ops)]
        ///
        /// use std::time::Duration;
        ///
        /// assert_eq!(Duration::new(2, 0).checked_div(2), Some(Duration::new(1, 0)));
        /// assert_eq!(Duration::new(1, 0).checked_div(2), Some(Duration::new(0, 500_000_000)));
        /// assert_eq!(Duration::new(2, 0).checked_div(0), None);
        /// ```
        #[unstable(feature = "duration_checked_ops", issue = "35774")]
        #[inline]
        pub fn checked_div(self, rhs: u32) -> Option<Duration> {
            if rhs != 0 {
                let secs = self.secs / (rhs as u64);
                let carry = self.secs - secs * (rhs as u64);
                let extra_nanos = carry * (NANOS_PER_SEC as u64) / (rhs as u64);
                let nanos = self.nanos / rhs + (extra_nanos as u32);
                debug_assert!(nanos < NANOS_PER_SEC);
                Some(Duration { secs: secs, nanos: nanos })
            } else {
                None
            }
        }
    }

    #[stable(feature = "duration", since = "1.3.0")]
    impl Add for Duration {
        type Output = Duration;

        fn add(self, rhs: Duration) -> Duration {
            self.checked_add(rhs).expect("overflow when adding durations")
        }
    }

    #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
    impl AddAssign for Duration {
        fn add_assign(&mut self, rhs: Duration) {
            *self = *self + rhs;
        }
    }

    #[stable(feature = "duration", since = "1.3.0")]
    impl Sub for Duration {
        type Output = Duration;

        fn sub(self, rhs: Duration) -> Duration {
            self.checked_sub(rhs).expect("overflow when subtracting durations")
        }
    }

    #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
    impl SubAssign for Duration {
        fn sub_assign(&mut self, rhs: Duration) {
            *self = *self - rhs;
        }
    }

    #[stable(feature = "duration", since = "1.3.0")]
    impl Mul<u32> for Duration {
        type Output = Duration;

        fn mul(self, rhs: u32) -> Duration {
            self.checked_mul(rhs).expect("overflow when multiplying duration by scalar")
        }
    }

    #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
    impl MulAssign<u32> for Duration {
        fn mul_assign(&mut self, rhs: u32) {
            *self = *self * rhs;
        }
    }

    #[stable(feature = "duration", since = "1.3.0")]
    impl Div<u32> for Duration {
        type Output = Duration;

        fn div(self, rhs: u32) -> Duration {
            self.checked_div(rhs).expect("divide by zero error when dividing duration by scalar")
        }
    }

    #[stable(feature = "time_augmented_assignment", since = "1.9.0")]
    impl DivAssign<u32> for Duration {
        fn div_assign(&mut self, rhs: u32) {
            *self = *self / rhs;
        }
    }

    #[cfg(test)]
    mod tests {
        use super::Duration;

        #[test]
        fn creation() {
            assert!(Duration::from_secs(1) != Duration::from_secs(0));
            assert_eq!(Duration::from_secs(1) + Duration::from_secs(2),
                       Duration::from_secs(3));
            assert_eq!(Duration::from_millis(10) + Duration::from_secs(4),
                       Duration::new(4, 10 * 1_000_000));
            assert_eq!(Duration::from_millis(4000), Duration::new(4, 0));
        }

        #[test]
        fn secs() {
            assert_eq!(Duration::new(0, 0).as_secs(), 0);
            assert_eq!(Duration::from_secs(1).as_secs(), 1);
            assert_eq!(Duration::from_millis(999).as_secs(), 0);
            assert_eq!(Duration::from_millis(1001).as_secs(), 1);
        }

        #[test]
        fn nanos() {
            assert_eq!(Duration::new(0, 0).subsec_nanos(), 0);
            assert_eq!(Duration::new(0, 5).subsec_nanos(), 5);
            assert_eq!(Duration::new(0, 1_000_000_001).subsec_nanos(), 1);
            assert_eq!(Duration::from_secs(1).subsec_nanos(), 0);
            assert_eq!(Duration::from_millis(999).subsec_nanos(), 999 * 1_000_000);
            assert_eq!(Duration::from_millis(1001).subsec_nanos(), 1 * 1_000_000);
        }

        #[test]
        fn add() {
            assert_eq!(Duration::new(0, 0) + Duration::new(0, 1),
                       Duration::new(0, 1));
            assert_eq!(Duration::new(0, 500_000_000) + Duration::new(0, 500_000_001),
                       Duration::new(1, 1));
        }

        #[test]
        fn checked_add() {
            assert_eq!(Duration::new(0, 0).checked_add(Duration::new(0, 1)),
                       Some(Duration::new(0, 1)));
            assert_eq!(Duration::new(0, 500_000_000).checked_add(Duration::new(0, 500_000_001)),
                       Some(Duration::new(1, 1)));
            assert_eq!(Duration::new(1, 0).checked_add(Duration::new(::u64::MAX, 0)), None);
        }

        #[test]
        fn sub() {
            assert_eq!(Duration::new(0, 1) - Duration::new(0, 0),
                       Duration::new(0, 1));
            assert_eq!(Duration::new(0, 500_000_001) - Duration::new(0, 500_000_000),
                       Duration::new(0, 1));
            assert_eq!(Duration::new(1, 0) - Duration::new(0, 1),
                       Duration::new(0, 999_999_999));
        }

        #[test]
        fn checked_sub() {
            let zero = Duration::new(0, 0);
            let one_nano = Duration::new(0, 1);
            let one_sec = Duration::new(1, 0);
            assert_eq!(one_nano.checked_sub(zero), Some(Duration::new(0, 1)));
            assert_eq!(one_sec.checked_sub(one_nano),
                       Some(Duration::new(0, 999_999_999)));
            assert_eq!(zero.checked_sub(one_nano), None);
            assert_eq!(zero.checked_sub(one_sec), None);
        }

        #[test] #[should_panic]
        fn sub_bad1() {
            Duration::new(0, 0) - Duration::new(0, 1);
        }

        #[test] #[should_panic]
        fn sub_bad2() {
            Duration::new(0, 0) - Duration::new(1, 0);
        }

        #[test]
        fn mul() {
            assert_eq!(Duration::new(0, 1) * 2, Duration::new(0, 2));
            assert_eq!(Duration::new(1, 1) * 3, Duration::new(3, 3));
            assert_eq!(Duration::new(0, 500_000_001) * 4, Duration::new(2, 4));
            assert_eq!(Duration::new(0, 500_000_001) * 4000,
                       Duration::new(2000, 4000));
        }

        #[test]
        fn checked_mul() {
            assert_eq!(Duration::new(0, 1).checked_mul(2), Some(Duration::new(0, 2)));
            assert_eq!(Duration::new(1, 1).checked_mul(3), Some(Duration::new(3, 3)));
            assert_eq!(Duration::new(0, 500_000_001).checked_mul(4), Some(Duration::new(2, 4)));
            assert_eq!(Duration::new(0, 500_000_001).checked_mul(4000),
                       Some(Duration::new(2000, 4000)));
            assert_eq!(Duration::new(::u64::MAX - 1, 0).checked_mul(2), None);
        }

        #[test]
        fn div() {
            assert_eq!(Duration::new(0, 1) / 2, Duration::new(0, 0));
            assert_eq!(Duration::new(1, 1) / 3, Duration::new(0, 333_333_333));
            assert_eq!(Duration::new(99, 999_999_000) / 100,
                       Duration::new(0, 999_999_990));
        }

        #[test]
        fn checked_div() {
            assert_eq!(Duration::new(2, 0).checked_div(2), Some(Duration::new(1, 0)));
            assert_eq!(Duration::new(1, 0).checked_div(2), Some(Duration::new(0, 500_000_000)));
            assert_eq!(Duration::new(2, 0).checked_div(0), None);
        }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)