bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rollup merge of #54646 - vn971:fix_std_thread_sleep, r=frewsxcv

Browse source 
improve documentation on std:🧵:sleep
This commit is contained in:
kennytm 2018-10-18 10:47:17 +08:00
commit e4ac447851
No known key found for this signature in database
GPG key ID: FEF6C8051D0E013C
1 changed files with 14 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

24
src/libstd/thread/mod.rs
View file

@ -650,15 +650,17 @@ pub fn panicking() -> bool {
panicking::panicking() panicking::panicking()
} }
/// Puts the current thread to sleep for the specified amount of time. /// Puts the current thread to sleep for at least the specified amount of time.
/// ///
/// The thread may sleep longer than the duration specified due to scheduling /// The thread may sleep longer than the duration specified due to scheduling
/// specifics or platform-dependent functionality. /// specifics or platform-dependent functionality. It will never sleep less.
/// ///
/// # Platform-specific behavior /// # Platform-specific behavior
/// ///
/// On Unix platforms this function will not return early due to a /// On Unix platforms, the underlying syscall may be interrupted by a
/// signal being received or a spurious wakeup. /// spurious wakeup or signal handler. To ensure the sleep occurs for at least
/// the specified duration, this function may invoke that system call multiple
/// times.
/// ///
/// # Examples /// # Examples
/// ///
@ -674,17 +676,19 @@ pub fn sleep_ms(ms: u32) {
sleep(Duration::from_millis(ms as u64)) sleep(Duration::from_millis(ms as u64))
} }
/// Puts the current thread to sleep for the specified amount of time. /// Puts the current thread to sleep for at least the specified amount of time.
/// ///
/// The thread may sleep longer than the duration specified due to scheduling /// The thread may sleep longer than the duration specified due to scheduling
/// specifics or platform-dependent functionality. /// specifics or platform-dependent functionality. It will never sleep less.
/// ///
/// # Platform-specific behavior /// # Platform-specific behavior
/// ///
/// On Unix platforms this function will not return early due to a /// On Unix platforms, the underlying syscall may be interrupted by a
/// signal being received or a spurious wakeup. Platforms which do not support /// spurious wakeup or signal handler. To ensure the sleep occurs for at least
/// nanosecond precision for sleeping will have `dur` rounded up to the nearest /// the specified duration, this function may invoke that system call multiple
/// granularity of time they can sleep for. /// times.
/// Platforms which do not support nanosecond precision for sleeping will
/// have `dur` rounded up to the nearest granularity of time they can sleep for.
/// ///
/// # Examples /// # Examples
/// ///