Skip to content

Commit

Permalink
Auto merge of #41811 - gamazeps:thread-panicking-doc, r=frewsxcv
Browse files Browse the repository at this point in the history
[DOC] Improve `thread::panicking` documentaion.

Part of #29378

Takes care of: `panicking` could use some more advice on when to use this.

I mays have done a poor choice of introducing `Mutex`s.

r? @steveklabnik
  • Loading branch information
bors committed May 7, 2017
2 parents 8d19877 + 12efc9d commit d985625
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/libstd/thread/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -458,6 +458,16 @@ pub fn yield_now() {

/// 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
///
/// ```should_panic
Expand Down Expand Up @@ -486,6 +496,8 @@ pub fn yield_now() {
/// panic!()
/// }
/// ```
///
/// [Mutex]: ../../std/sync/struct.Mutex.html
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
pub fn panicking() -> bool {
Expand Down

0 comments on commit d985625

Please sign in to comment.