Skip to content

Commit

Permalink
Clarify difference between unix/windows behaviour
Browse files Browse the repository at this point in the history
Updated to specify the underlying syscalls
  • Loading branch information
Digital-Chaos committed Jan 15, 2021
1 parent 1700ca0 commit 8a85a85
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions library/std/src/thread/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -775,6 +775,14 @@ 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
Expand Down

0 comments on commit 8a85a85

Please sign in to comment.