From: Alexis Bourget <alexis.bourget@gmail.com>
Date: Mon, 15 Jun 2020 13:19:02 +0000 (+0200)
Subject: Complete the std::time documentation to warn about the inconsistencies between OS
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=9e510085ecaedaee86b44410a4b3e4c85d97d6e0;p=rust.git

Complete the std::time documentation to warn about the inconsistencies between OS
---

diff --git a/src/libstd/time.rs b/src/libstd/time.rs
index c36e78b1d00..c58168bd446 100644
--- a/src/libstd/time.rs
+++ b/src/libstd/time.rs
@@ -60,6 +60,21 @@
 /// }
 /// ```
 ///
+/// # OS-specific behaviors
+///
+/// An `Instant` is a wrapper around system-specific types and it may behave
+/// differently depending on the underlying operating system. For example,
+/// the following snippet is fine on Linux but panics on macOS:
+///
+/// ```no_run
+/// use std::time::{Instant, Duration};
+///
+/// let now = Instant::now();
+/// let max_nanoseconds = u64::MAX / 1_000_000_000;
+/// let duration = Duration::new(max_nanoseconds, 0);
+/// println!("{:?}", now + duration);
+/// ```
+///
 /// # Underlying System calls
 /// Currently, the following system calls are being used to get the current time using `now()`:
 ///