Skip to content

Commit

Permalink
Auto merge of #116157 - the8472:doc-monotonoic-suspend, r=Mark-Simula…
Browse files Browse the repository at this point in the history
…crum

Document that Instant may or may not include system-suspend time

Since people are still occasionally surprised by this let's make it more explicit. This doesn't add any new guarantees, only documents the status quo.

Related issues: #87906 #79462
  • Loading branch information
bors committed Sep 30, 2023
2 parents bb6c66b + b0412d5 commit 2f89c41
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions library/std/src/time.rs
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ pub use core::time::TryFromFloatSecsError;
/// some seconds may be longer than others). An instant may jump forwards or
/// experience time dilation (slow down or speed up), but it will never go
/// backwards.
/// As part of this non-guarantee it is also not specified whether system suspends count as
/// elapsed time or not. The behavior varies across platforms and rust versions.
///
/// Instants are opaque types that can only be compared to one another. There is
/// no method to get "the number of seconds" from an instant. Instead, it only
Expand Down

0 comments on commit 2f89c41

Please sign in to comment.