1
Fork 0

Improve thread::panicking documentaion.

Part of #29378
This commit is contained in:
Felix Raimundo 2017-05-07 16:49:18 +02:00
parent ced823e267
commit 12efc9d0fa

View file

@ -458,6 +458,16 @@ pub fn yield_now() {
/// Determines whether the current thread is unwinding because of panic. /// Determines whether the current thread is unwinding because of panic.
/// ///
/// A common use of this feature is to poison shared resources when writing
/// unsafe code, by checking `panicking` when the `drop` is called.
///
/// This is usually not needed when writing safe code, as [`Mutex`es][Mutex]
/// already poison themselves when a thread panics while holding the lock.
///
/// This can also be used in multithreaded applications, in order to send a
/// message to other threads warning that a thread has panicked (e.g. for
/// monitoring purposes).
///
/// # Examples /// # Examples
/// ///
/// ```should_panic /// ```should_panic
@ -486,6 +496,8 @@ pub fn yield_now() {
/// panic!() /// panic!()
/// } /// }
/// ``` /// ```
///
/// [Mutex]: ../../std/sync/struct.Mutex.html
#[inline] #[inline]
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
pub fn panicking() -> bool { pub fn panicking() -> bool {