diff options
| author | Corey Farwell <coreyf@rwell.org> | 2017-05-03 18:34:02 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-05-03 18:34:02 -0400 |
| commit | 3bfc72fba6ca3441d2e352a13d8fc648700d6054 (patch) | |
| tree | 58a9855a82ddb74e650cab981810e9f3fb8aee26 /src/libstd | |
| parent | e2cedb249f00460247c015c9470b0a3e6d4fca85 (diff) | |
| parent | a3e8f3622f62022d98c2df1f096f4ef88efb6386 (diff) | |
| download | rust-3bfc72fba6ca3441d2e352a13d8fc648700d6054.tar.gz rust-3bfc72fba6ca3441d2e352a13d8fc648700d6054.zip | |
Rollup merge of #41720 - frewsxcv:duration-doc-examples, r=steveklabnik
Improvements to `std::time::Duration` doc examples. Opened primarily for the last commit, in response to comments in https://github.com/rust-lang/rust/issues/39949.
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/time/duration.rs | 29 |
1 files changed, 25 insertions, 4 deletions
diff --git a/src/libstd/time/duration.rs b/src/libstd/time/duration.rs index af7eaeb3106..55766ba3fed 100644 --- a/src/libstd/time/duration.rs +++ b/src/libstd/time/duration.rs @@ -84,7 +84,10 @@ impl Duration { /// ``` /// use std::time::Duration; /// - /// let five_seconds = Duration::from_secs(5); + /// let duration = Duration::from_secs(5); + /// + /// assert_eq!(5, duration.as_secs()); + /// assert_eq!(0, duration.subsec_nanos()); /// ``` #[stable(feature = "duration", since = "1.3.0")] #[inline] @@ -99,7 +102,10 @@ impl Duration { /// ``` /// use std::time::Duration; /// - /// let five_seconds = Duration::from_millis(5000); + /// let duration = Duration::from_millis(2569); + /// + /// assert_eq!(2, duration.as_secs()); + /// assert_eq!(569000000, duration.subsec_nanos()); /// ``` #[stable(feature = "duration", since = "1.3.0")] #[inline] @@ -119,9 +125,24 @@ impl Duration { /// ``` /// use std::time::Duration; /// - /// let five_seconds = Duration::new(5, 0); - /// assert_eq!(five_seconds.as_secs(), 5); + /// let duration = Duration::new(5, 730023852); + /// assert_eq!(duration.as_secs(), 5); + /// ``` + /// + /// To determine the total number of seconds represented by the `Duration`, + /// use `as_secs` in combination with [`subsec_nanos`]: + /// /// ``` + /// use std::time::Duration; + /// + /// let duration = Duration::new(5, 730023852); + /// + /// assert_eq!(5.730023852, + /// duration.as_secs() as f64 + /// + duration.subsec_nanos() as f64 * 1e-9); + /// ``` + /// + /// [`subsec_nanos`]: #method.subsec_nanos #[stable(feature = "duration", since = "1.3.0")] #[inline] pub fn as_secs(&self) -> u64 { self.secs } |
