bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rollup merge of #79849 - Digital-Chaos:sleep-zero, r=m-ou-se

Browse source 
Clarify docs regarding sleep of zero duration

Clarify that the behaviour of sleep() when given a duration of zero is actually platform specific.
This commit is contained in:
Yuki Okushi 2021-02-10 12:24:18 +09:00 • committed by GitHub
commit bb06b13131
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
library/std/src/thread/mod.rs
View file

@ -775,6 +775,15 @@ pub fn sleep_ms(ms: u32) {
/// Platforms which do not support nanosecond precision for sleeping will
/// have `dur` rounded up to the nearest granularity of time they can sleep for.
///
/// Currently, specifying a zero duration on Unix platforms returns immediately
/// without invoking the underlying [`nanosleep`] syscall, whereas on Windows
/// platforms the underlying [`Sleep`] syscall is always invoked.
/// If the intention is to yield the current time-slice you may want to use
/// [`yield_now`] instead.
///
/// [`nanosleep`]: https://linux.die.net/man/2/nanosleep
/// [`Sleep`]: https://docs.microsoft.com/en-us/windows/win32/api/synchapi/nf-synchapi-sleep
///
/// # Examples
///
/// ```no_run