diff options
| author | Alice Ryhl <alice@ryhl.io> | 2020-11-11 20:31:22 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-11 11:31:22 -0800 |
| commit | 9d0c0dd22cfa028af63798671c781b1fd83562e2 (patch) | |
| tree | 40f9a0157935c2eba739cedcb466bc1e801e7875 /tokio | |
| parent | 6d5423f3e9b32ab02d6796ebfaafefd890a7593b (diff) | |
time: document maximum sleep duration (#3126)
Diffstat (limited to 'tokio')
| -rw-r--r-- | tokio/src/time/sleep.rs | 2 | ||||
| -rw-r--r-- | tokio/tests/time_sleep.rs | 1 |
2 files changed, 3 insertions, 0 deletions
diff --git a/tokio/src/time/sleep.rs b/tokio/src/time/sleep.rs index d3234a18..2bd4eb1a 100644 --- a/tokio/src/time/sleep.rs +++ b/tokio/src/time/sleep.rs @@ -31,6 +31,8 @@ pub fn sleep_until(deadline: Instant) -> Sleep { /// /// To run something regularly on a schedule, see [`interval`]. /// +/// The maximum duration for a sleep is 68719476734 milliseconds (approximately 2.2 years). +/// /// # Cancellation /// /// Canceling a sleep instance is done by dropping the returned future. No additional diff --git a/tokio/tests/time_sleep.rs b/tokio/tests/time_sleep.rs index 87d69dee..955d833b 100644 --- a/tokio/tests/time_sleep.rs +++ b/tokio/tests/time_sleep.rs @@ -182,6 +182,7 @@ const MAX_DURATION: u64 = (1 << (6 * NUM_LEVELS)) - 1; #[tokio::test] async fn exactly_max() { // TODO: this should not panic but `time::ms()` is acting up + // If fixed, make sure to update documentation on `time::sleep` too. time::sleep(ms(MAX_DURATION)).await; } |