Skip to content

update panicking() docs for panic=abort #153295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
biscuitrescue wants to merge 2 commits into
base: main
Choose a base branch
from
+13 −9
Open

update panicking() docs for panic=abort #153295

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7072f83
update panicking() docs for panic=abort
biscuitrescue Mar 2, 2026
bf08176
rephrasing and grammar
biscuitrescue Mar 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions library/std/src/thread/functions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,11 @@ pub fn yield_now() {
imp::yield_now()
}

/// Determines whether the current thread is unwinding because of panic.
/// Determines whether the current thread is panicking.
///
/// Note that this returns `true` both when the thread is unwinding due to a
/// panic or executing a panic hook. The latter case will still happen when
Comment on lines +173 to +174
Copy link
Contributor

@tgross35 tgross35 Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This returns true when the thread is either unwinding due to a panic, or when it is executing a panic hook. Note that the latter case ...

Minor rewording suggestion to move the "note" bit to the second sentence since it's more of a note, and slightly smooth out the first sentence.

Please squash commits after this then LGTM, thanks for the additional fixes

/// `panic=abort` is set.
///
/// A common use of this feature is to poison shared resources when writing
/// unsafe code, by checking `panicking` when the `drop` is called.
Expand Down Expand Up @@ -309,14 +313,14 @@ pub fn sleep(dur: Duration) {
///
/// | Platform | System call |
/// |-----------|----------------------------------------------------------------------|
/// | Linux | [clock_nanosleep] (Monotonic clock) |
/// | BSD except OpenBSD | [clock_nanosleep] (Monotonic Clock)] |
/// | Android | [clock_nanosleep] (Monotonic Clock)] |
/// | Solaris | [clock_nanosleep] (Monotonic Clock)] |
/// | Illumos | [clock_nanosleep] (Monotonic Clock)] |
/// | Dragonfly | [clock_nanosleep] (Monotonic Clock)] |
/// | Hurd | [clock_nanosleep] (Monotonic Clock)] |
/// | Vxworks | [clock_nanosleep] (Monotonic Clock)] |
/// | Linux | [clock_nanosleep] (Monotonic Clock) |
/// | BSD except OpenBSD | [clock_nanosleep] (Monotonic Clock) |
/// | Android | [clock_nanosleep] (Monotonic Clock) |
/// | Solaris | [clock_nanosleep] (Monotonic Clock) |
/// | Illumos | [clock_nanosleep] (Monotonic Clock) |
/// | Dragonfly | [clock_nanosleep] (Monotonic Clock) |
/// | Hurd | [clock_nanosleep] (Monotonic Clock) |
/// | Vxworks | [clock_nanosleep] (Monotonic Clock) |
/// | Apple | `mach_wait_until` |
/// | Other | `sleep_until` uses [`sleep`] and does not issue a syscall itself |
///
Expand Down
Loading