bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Add caveat about the monotonicity guarantee by linking to the later section

Browse source
This commit is contained in:
The 8472 2022-01-07 10:50:15 +01:00
parent 9d8ef11607
commit bda2693e9b
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
library/std/src/time.rs
View file

@ -49,8 +49,8 @@ pub use core::time::FromFloatSecsError;
/// A measurement of a monotonically nondecreasing clock. /// A measurement of a monotonically nondecreasing clock.
/// Opaque and useful only with [`Duration`]. /// Opaque and useful only with [`Duration`].
/// ///
/// Instants are always guaranteed to be no less than any previously measured /// Instants are always guaranteed, barring [platform bugs], to be no less than any previously
/// instant when created, and are often useful for tasks such as measuring /// measured instant when created, and are often useful for tasks such as measuring
/// benchmarks or timing how long an operation takes. /// benchmarks or timing how long an operation takes.
/// ///
/// Note, however, that instants are **not** guaranteed to be **steady**. In other /// Note, however, that instants are **not** guaranteed to be **steady**. In other
@ -83,6 +83,8 @@ pub use core::time::FromFloatSecsError;
/// } /// }
/// ``` /// ```
/// ///
/// [platform bugs]: Instant#monotonicity
///
/// # OS-specific behaviors /// # OS-specific behaviors
/// ///
/// An `Instant` is a wrapper around system-specific types and it may behave /// An `Instant` is a wrapper around system-specific types and it may behave