Documented thread hooks on panics and errors of thread spawning functions. #149927
+35
−7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… spawning functions.
rustbot
added
S-waiting-on-review
Collaborator
joboet
requested changes
Dec 12, 2025
library/std/src/thread/builder.rs
Outdated
| /// | ||
| /// Panics if a thread name was set and it contained null bytes. | ||
| /// | ||
| /// Unlike the [`spawn`] free function, if it panics for this reason, the |
Member
There was a problem hiding this comment.
Unlike the
spawnfree function
thread::spawn calls Builder::spawn internally, so this is misleading – it's just that thread::spawn doesn't set a thread name and thus will never panic for this reason.
library/std/src/thread/functions.rs
Outdated
| /// Panics if the OS fails to create a thread; use [`Builder::spawn`] to recover | ||
| /// from such errors. | ||
| /// | ||
| /// Additionally, if hooks were added via [`add_spawn_hook`], they will still be |
Member
There was a problem hiding this comment.
"Additionally" isn't a good phrasing here, this isn't describing another panicking case, but rather adding more detail to the previous sentence. How about just combining the two paragraphs without any conjunction? Like
Panics if the OS fails to create a thread; use
Builder::spawnto recover from such errors. If hooks...
library/std/src/thread/scoped.rs
Outdated
| /// Panics if the OS fails to create a thread; use [`Builder::spawn_scoped`] | ||
| /// to recover from such errors. | ||
| /// | ||
| /// like the free [`spawn`] function, if hooks were added via [`add_spawn_hook`], |
Member
There was a problem hiding this comment.
This should then match the thread::spawn documentation exactly.
library/std/src/thread/scoped.rs
Outdated
| /// Panics if a thread name was set and it contained null bytes. | ||
| /// | ||
| /// Unlike with [`Scope::spawn`], if it panics for this reason, the hooks | ||
| /// added by [`add_spawn_hook`] will _not_ be called. |
rustbot
added
S-waiting-on-author
Collaborator
|
Reminder, once the PR becomes ready for a review, use |
Reword documentation for clarity regarding spawn hooks.
Removed unused documentation reference to `spawn` in scoped thread.
Author
|
@rustbot ready |
rustbot
added
S-waiting-on-review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR solves a concern regarding #132951
Considering that the feature has been on nightly for over a year, I would also like to see it stabilized, since no one has voiced any concerns about its current implementation.