about summary refs log tree commit diff
path: root/library/std/src/time.rs
diff options
context:
space:
mode:
authorThe 8472 <git@infinite-source.de>2023-09-25 19:54:26 +0200
committerThe 8472 <git@infinite-source.de>2023-09-25 19:54:26 +0200
commitb0412d597e75d66ac5f07c642abae49c739d4fde (patch)
tree03568b0ba6b0f11aaa67256e9320f1cd87eb4ccf /library/std/src/time.rs
parent9d32ba3a7219e28b0d44b5eb4d564ca58114356f (diff)
downloadrust-b0412d597e75d66ac5f07c642abae49c739d4fde.tar.gz
rust-b0412d597e75d66ac5f07c642abae49c739d4fde.zip
Document that Instant may or may not include system-suspend time
Diffstat (limited to 'library/std/src/time.rs')
-rw-r--r--library/std/src/time.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/library/std/src/time.rs b/library/std/src/time.rs
index c638cc61856..005d8c76704 100644
--- a/library/std/src/time.rs
+++ b/library/std/src/time.rs
@@ -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