about summary refs log tree commit diff
path: root/src/libstd/time
diff options
context:
space:
mode:
authorCorey Farwell <coreyf@rwell.org>2016-09-06 21:10:15 -0400
committerCorey Farwell <coreyf@rwell.org>2016-09-07 09:23:17 -0400
commit102b3a937b8bb5ef601fd586a3d9ffcd518d6bf3 (patch)
tree01cdf43acb0dac6ce0be2215f6236930b53df8c7 /src/libstd/time
parent923bac45964940c56ab1075fb7980896de1eb620 (diff)
downloadrust-102b3a937b8bb5ef601fd586a3d9ffcd518d6bf3.tar.gz
rust-102b3a937b8bb5ef601fd586a3d9ffcd518d6bf3.zip
Add doc example for `std::time::Instant::elapsed`.
Diffstat (limited to 'src/libstd/time')
-rw-r--r--src/libstd/time/mod.rs12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/libstd/time/mod.rs b/src/libstd/time/mod.rs
index 0e1508a1c4c..154f603c84f 100644
--- a/src/libstd/time/mod.rs
+++ b/src/libstd/time/mod.rs
@@ -150,6 +150,18 @@ impl Instant {
     /// This function may panic if the current time is earlier than this
     /// instant, which is something that can happen if an `Instant` is
     /// produced synthetically.
+    ///
+    /// # Examples
+    ///
+    /// ```no_run
+    /// use std::thread::sleep;
+    /// use std::time::{Duration, Instant};
+    ///
+    /// let instant = Instant::now();
+    /// let three_secs = Duration::from_secs(3);
+    /// sleep(three_secs);
+    /// assert!(instant.elapsed() >= three_secs);
+    /// ```
     #[stable(feature = "time2", since = "1.8.0")]
     pub fn elapsed(&self) -> Duration {
         Instant::now() - *self