Documented thread hooks on panics and errors of thread spawning functions.#149927

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
AhoyISki wants to merge 1 commit into
base:main
Choose a base branch
from
Open

Documented thread hooks on panics and errors of thread spawning functions. #149927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions library/std/src/thread/builder.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -160,10 +160,18 @@ impl Builder {
/// [`io::Result`] to capture any failure to create the thread at
/// the OS level.
///
/// Like [`spawn`], this method will still call the main thread functions

@nia-enia-eAug 28, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This should disambiguate the spawn being referred to (i.e. "like the free spawn function")

/// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
/// but won't execute the returned functions if thread creation fails at the
/// OS level.
///
/// # Panics
///
/// Panics if a thread name was set and it contained null bytes.
///
/// Unlike the [`spawn`] free function, if it panics for this reason, the
/// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
///
/// # Examples
///
/// ```
Expand All@@ -178,8 +186,10 @@ impl Builder {
/// handler.join().unwrap();
/// ```
///
/// [`io::Result`]: crate::io::Result
/// [`thread::spawn`]: super::spawn
/// [`spawn`]: super::spawn
/// [`add_spawn_hook`]: crate::thread::add_spawn_hook
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
pub fn spawn<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand DownExpand Up@@ -209,10 +219,18 @@ impl Builder {
/// [`io::Result`] to capture any failure to create the thread at
/// the OS level.
///
/// Like [`spawn`], this method will still call the main thread functions
/// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
/// but won't execute the returned functions if thread creation fails at the
/// OS level.
///
/// # Panics
///
/// Panics if a thread name was set and it contained null bytes.
///
/// Unlike the [`spawn`] free function, if it panics for this reason, the
/// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
///
/// # Safety
///
/// The caller has to ensure that the spawned thread does not outlive any
Expand DownExpand Up@@ -249,6 +267,7 @@ impl Builder {
///
/// [`thread::spawn`]: super::spawn
/// [`spawn`]: super::spawn
/// [`add_spawn_hook`]: crate::thread::add_spawn_hook
#[stable(feature = "thread_spawn_unchecked", since = "1.82.0")]
#[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
pub unsafe fn spawn_unchecked<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand Down
8 changes: 6 additions & 2 deletions library/std/src/thread/functions.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,11 @@ use crate::{io, panicking};
///
/// # Panics
///
/// Panics if the OS fails to create a thread; use [`Builder::spawn`]
/// to recover from such errors.
/// 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
/// called in the parent thread, but the returned functions will not be executed.
///
/// # Examples
///
Expand DownExpand Up@@ -120,6 +123,7 @@ use crate::{io, panicking};
/// [`channels`]: crate::sync::mpsc
/// [`join`]: JoinHandle::join
/// [`Err`]: crate::result::Result::Err
/// [`add_spawn_hook`]: crate::thread::add_spawn_hook
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
pub fn spawn<F, T>(f: F) -> JoinHandle<T>
Expand Down
17 changes: 17 additions & 0 deletions library/std/src/thread/scoped.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -196,7 +196,13 @@ impl<'scope, 'env> Scope<'scope, 'env> {
/// 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`],
/// they will still be called in the parent thread, but the returned functions will
/// not be executed.
///
/// [`join`]: ScopedJoinHandle::join
/// [`add_spawn_hook`]: crate::thread::add_spawn_hook
/// [`spawn`]: crate::thread::spawn
#[stable(feature = "scoped_threads", since = "1.63.0")]
pub fn spawn<F, T>(&'scope self, f: F) -> ScopedJoinHandle<'scope, T>
where
Expand All@@ -213,10 +219,18 @@ impl Builder {
/// Unlike [`Scope::spawn`], this method yields an [`io::Result`] to
/// capture any failure to create the thread at the OS level.
///
/// Like [`Scope::spawn`], this method will still call the main thread functions
/// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
/// but won't execute the returned functions if thread creation fails at the
/// OS level.
///
/// # Panics
///
/// 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.
///
/// # Example
///
/// ```
Expand DownExpand Up@@ -252,6 +266,9 @@ impl Builder {
/// a.push(4);
/// assert_eq!(x, a.len());
/// ```
///
/// [`io::Result`]: crate::io::Result
/// [`add_spawn_hook`]: crate::thread::add_spawn_hook
#[stable(feature = "scoped_threads", since = "1.63.0")]
pub fn spawn_scoped<'scope, 'env, F, T>(
self,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Documented thread hooks on panics and errors of thread spawning functions.#149927

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

AhoyISki
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


Documented thread hooks on panics and errors of thread spawning functions.
#149927
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
library/std/src/thread/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,10 +160,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
@nia-enia-eAug 28, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This should disambiguate the spawn being referred to (i.e. "like the free spawn function")
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Examples
 ///
 /// ```
Expand All@@ -178,8 +186,10 @@ impl Builder {
 /// handler.join().unwrap();
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "rust1", since = "1.0.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub fn spawn<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand DownExpand Up@@ -209,10 +219,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Safety
 ///
 /// The caller has to ensure that the spawned thread does not outlive any
Expand DownExpand Up@@ -249,6 +267,7 @@ impl Builder {
 ///
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "thread_spawn_unchecked", since = "1.82.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub unsafe fn spawn_unchecked<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand Down

8 changes: 6 additions & 2 deletions
library/std/src/thread/functions.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,11 @@ use crate::{io, panicking};
///
/// # Panics
///
/// Panics if the OS fails to create a thread; use [`Builder::spawn`]
/// to recover from such errors.
/// 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
/// called in the parent thread, but the returned functions will not be executed.
///
/// # Examples
///
Expand DownExpand Up@@ -120,6 +123,7 @@ use crate::{io, panicking};
/// [`channels`]: crate::sync::mpsc
/// [`join`]: JoinHandle::join
/// [`Err`]: crate::result::Result::Err
/// [`add_spawn_hook`]: crate::thread::add_spawn_hook
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
pub fn spawn<F, T>(f: F) -> JoinHandle<T>
Expand Down

17 changes: 17 additions & 0 deletions
library/std/src/thread/scoped.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -196,7 +196,13 @@ impl<'scope, 'env> Scope<'scope, 'env> {
 /// 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`],
 /// they will still be called in the parent thread, but the returned functions will
 /// not be executed.
 ///
 /// [`join`]: ScopedJoinHandle::join
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 /// [`spawn`]: crate::thread::spawn
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn<F, T>(&'scope self, f: F) -> ScopedJoinHandle<'scope, T>
 where
Expand All@@ -213,10 +219,18 @@ impl Builder {
 /// Unlike [`Scope::spawn`], this method yields an [`io::Result`] to
 /// capture any failure to create the thread at the OS level.
 ///
 /// Like [`Scope::spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// 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.
 ///
 /// # Example
 ///
 /// ```
Expand DownExpand Up@@ -252,6 +266,9 @@ impl Builder {
 /// a.push(4);
 /// assert_eq!(x, a.len());
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn_scoped<'scope, 'env, F, T>(
 self,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Documented thread hooks on panics and errors of thread spawning functions.#149927

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

AhoyISki
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


Documented thread hooks on panics and errors of thread spawning functions.
#149927
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
library/std/src/thread/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,10 +160,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
@nia-enia-eAug 28, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This should disambiguate the spawn being referred to (i.e. "like the free spawn function")
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Examples
 ///
 /// ```
Expand All@@ -178,8 +186,10 @@ impl Builder {
 /// handler.join().unwrap();
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "rust1", since = "1.0.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub fn spawn<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand DownExpand Up@@ -209,10 +219,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Safety
 ///
 /// The caller has to ensure that the spawned thread does not outlive any
Expand DownExpand Up@@ -249,6 +267,7 @@ impl Builder {
 ///
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "thread_spawn_unchecked", since = "1.82.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub unsafe fn spawn_unchecked<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand Down

8 changes: 6 additions & 2 deletions
library/std/src/thread/functions.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,11 @@ use crate::{io, panicking};
///
/// # Panics
///
/// Panics if the OS fails to create a thread; use [`Builder::spawn`]
/// to recover from such errors.
/// 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
/// called in the parent thread, but the returned functions will not be executed.
///
/// # Examples
///
Expand DownExpand Up@@ -120,6 +123,7 @@ use crate::{io, panicking};
/// [`channels`]: crate::sync::mpsc
/// [`join`]: JoinHandle::join
/// [`Err`]: crate::result::Result::Err
/// [`add_spawn_hook`]: crate::thread::add_spawn_hook
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
pub fn spawn<F, T>(f: F) -> JoinHandle<T>
Expand Down

17 changes: 17 additions & 0 deletions
library/std/src/thread/scoped.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -196,7 +196,13 @@ impl<'scope, 'env> Scope<'scope, 'env> {
 /// 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`],
 /// they will still be called in the parent thread, but the returned functions will
 /// not be executed.
 ///
 /// [`join`]: ScopedJoinHandle::join
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 /// [`spawn`]: crate::thread::spawn
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn<F, T>(&'scope self, f: F) -> ScopedJoinHandle<'scope, T>
 where
Expand All@@ -213,10 +219,18 @@ impl Builder {
 /// Unlike [`Scope::spawn`], this method yields an [`io::Result`] to
 /// capture any failure to create the thread at the OS level.
 ///
 /// Like [`Scope::spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// 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.
 ///
 /// # Example
 ///
 /// ```
Expand DownExpand Up@@ -252,6 +266,9 @@ impl Builder {
 /// a.push(4);
 /// assert_eq!(x, a.len());
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn_scoped<'scope, 'env, F, T>(
 self,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Documented thread hooks on panics and errors of thread spawning functions.#149927

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

AhoyISki
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


Documented thread hooks on panics and errors of thread spawning functions.
#149927
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
library/std/src/thread/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,10 +160,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
@nia-enia-eAug 28, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This should disambiguate the spawn being referred to (i.e. "like the free spawn function")
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Examples
 ///
 /// ```
Expand All@@ -178,8 +186,10 @@ impl Builder {
 /// handler.join().unwrap();
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "rust1", since = "1.0.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub fn spawn<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand DownExpand Up@@ -209,10 +219,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Safety
 ///
 /// The caller has to ensure that the spawned thread does not outlive any
Expand DownExpand Up@@ -249,6 +267,7 @@ impl Builder {
 ///
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "thread_spawn_unchecked", since = "1.82.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub unsafe fn spawn_unchecked<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand Down

8 changes: 6 additions & 2 deletions
library/std/src/thread/functions.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,11 @@ use crate::{io, panicking};
///
/// # Panics
///
/// Panics if the OS fails to create a thread; use [`Builder::spawn`]
/// to recover from such errors.
/// 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
/// called in the parent thread, but the returned functions will not be executed.
///
/// # Examples
///
Expand DownExpand Up@@ -120,6 +123,7 @@ use crate::{io, panicking};
/// [`channels`]: crate::sync::mpsc
/// [`join`]: JoinHandle::join
/// [`Err`]: crate::result::Result::Err
/// [`add_spawn_hook`]: crate::thread::add_spawn_hook
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
pub fn spawn<F, T>(f: F) -> JoinHandle<T>
Expand Down

17 changes: 17 additions & 0 deletions
library/std/src/thread/scoped.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -196,7 +196,13 @@ impl<'scope, 'env> Scope<'scope, 'env> {
 /// 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`],
 /// they will still be called in the parent thread, but the returned functions will
 /// not be executed.
 ///
 /// [`join`]: ScopedJoinHandle::join
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 /// [`spawn`]: crate::thread::spawn
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn<F, T>(&'scope self, f: F) -> ScopedJoinHandle<'scope, T>
 where
Expand All@@ -213,10 +219,18 @@ impl Builder {
 /// Unlike [`Scope::spawn`], this method yields an [`io::Result`] to
 /// capture any failure to create the thread at the OS level.
 ///
 /// Like [`Scope::spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// 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.
 ///
 /// # Example
 ///
 /// ```
Expand DownExpand Up@@ -252,6 +266,9 @@ impl Builder {
 /// a.push(4);
 /// assert_eq!(x, a.len());
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn_scoped<'scope, 'env, F, T>(
 self,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Documented thread hooks on panics and errors of thread spawning functions.#149927

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

AhoyISki
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


Documented thread hooks on panics and errors of thread spawning functions.
#149927
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
library/std/src/thread/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,10 +160,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
@nia-enia-eAug 28, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This should disambiguate the spawn being referred to (i.e. "like the free spawn function")
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Examples
 ///
 /// ```
Expand All@@ -178,8 +186,10 @@ impl Builder {
 /// handler.join().unwrap();
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "rust1", since = "1.0.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub fn spawn<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand DownExpand Up@@ -209,10 +219,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Safety
 ///
 /// The caller has to ensure that the spawned thread does not outlive any
Expand DownExpand Up@@ -249,6 +267,7 @@ impl Builder {
 ///
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "thread_spawn_unchecked", since = "1.82.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub unsafe fn spawn_unchecked<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand Down

8 changes: 6 additions & 2 deletions
library/std/src/thread/functions.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,11 @@ use crate::{io, panicking};
///
/// # Panics
///
/// Panics if the OS fails to create a thread; use [`Builder::spawn`]
/// to recover from such errors.
/// 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
/// called in the parent thread, but the returned functions will not be executed.
///
/// # Examples
///
Expand DownExpand Up@@ -120,6 +123,7 @@ use crate::{io, panicking};
/// [`channels`]: crate::sync::mpsc
/// [`join`]: JoinHandle::join
/// [`Err`]: crate::result::Result::Err
/// [`add_spawn_hook`]: crate::thread::add_spawn_hook
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
pub fn spawn<F, T>(f: F) -> JoinHandle<T>
Expand Down

17 changes: 17 additions & 0 deletions
library/std/src/thread/scoped.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -196,7 +196,13 @@ impl<'scope, 'env> Scope<'scope, 'env> {
 /// 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`],
 /// they will still be called in the parent thread, but the returned functions will
 /// not be executed.
 ///
 /// [`join`]: ScopedJoinHandle::join
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 /// [`spawn`]: crate::thread::spawn
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn<F, T>(&'scope self, f: F) -> ScopedJoinHandle<'scope, T>
 where
Expand All@@ -213,10 +219,18 @@ impl Builder {
 /// Unlike [`Scope::spawn`], this method yields an [`io::Result`] to
 /// capture any failure to create the thread at the OS level.
 ///
 /// Like [`Scope::spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// 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.
 ///
 /// # Example
 ///
 /// ```
Expand DownExpand Up@@ -252,6 +266,9 @@ impl Builder {
 /// a.push(4);
 /// assert_eq!(x, a.len());
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn_scoped<'scope, 'env, F, T>(
 self,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Documented thread hooks on panics and errors of thread spawning functions.#149927

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

AhoyISki
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


Documented thread hooks on panics and errors of thread spawning functions.
#149927
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
library/std/src/thread/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,10 +160,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
@nia-enia-eAug 28, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This should disambiguate the spawn being referred to (i.e. "like the free spawn function")
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Examples
 ///
 /// ```
Expand All@@ -178,8 +186,10 @@ impl Builder {
 /// handler.join().unwrap();
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "rust1", since = "1.0.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub fn spawn<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand DownExpand Up@@ -209,10 +219,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Safety
 ///
 /// The caller has to ensure that the spawned thread does not outlive any
Expand DownExpand Up@@ -249,6 +267,7 @@ impl Builder {
 ///
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "thread_spawn_unchecked", since = "1.82.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub unsafe fn spawn_unchecked<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand Down

8 changes: 6 additions & 2 deletions
library/std/src/thread/functions.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,11 @@ use crate::{io, panicking};
///
/// # Panics
///
/// Panics if the OS fails to create a thread; use [`Builder::spawn`]
/// to recover from such errors.
/// 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
/// called in the parent thread, but the returned functions will not be executed.
///
/// # Examples
///
Expand DownExpand Up@@ -120,6 +123,7 @@ use crate::{io, panicking};
/// [`channels`]: crate::sync::mpsc
/// [`join`]: JoinHandle::join
/// [`Err`]: crate::result::Result::Err
/// [`add_spawn_hook`]: crate::thread::add_spawn_hook
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
pub fn spawn<F, T>(f: F) -> JoinHandle<T>
Expand Down

17 changes: 17 additions & 0 deletions
library/std/src/thread/scoped.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -196,7 +196,13 @@ impl<'scope, 'env> Scope<'scope, 'env> {
 /// 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`],
 /// they will still be called in the parent thread, but the returned functions will
 /// not be executed.
 ///
 /// [`join`]: ScopedJoinHandle::join
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 /// [`spawn`]: crate::thread::spawn
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn<F, T>(&'scope self, f: F) -> ScopedJoinHandle<'scope, T>
 where
Expand All@@ -213,10 +219,18 @@ impl Builder {
 /// Unlike [`Scope::spawn`], this method yields an [`io::Result`] to
 /// capture any failure to create the thread at the OS level.
 ///
 /// Like [`Scope::spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// 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.
 ///
 /// # Example
 ///
 /// ```
Expand DownExpand Up@@ -252,6 +266,9 @@ impl Builder {
 /// a.push(4);
 /// assert_eq!(x, a.len());
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn_scoped<'scope, 'env, F, T>(
 self,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Documented thread hooks on panics and errors of thread spawning functions.#149927

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

AhoyISki
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


Documented thread hooks on panics and errors of thread spawning functions.
#149927
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
library/std/src/thread/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,10 +160,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
@nia-enia-eAug 28, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This should disambiguate the spawn being referred to (i.e. "like the free spawn function")
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Examples
 ///
 /// ```
Expand All@@ -178,8 +186,10 @@ impl Builder {
 /// handler.join().unwrap();
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "rust1", since = "1.0.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub fn spawn<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand DownExpand Up@@ -209,10 +219,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Safety
 ///
 /// The caller has to ensure that the spawned thread does not outlive any
Expand DownExpand Up@@ -249,6 +267,7 @@ impl Builder {
 ///
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "thread_spawn_unchecked", since = "1.82.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub unsafe fn spawn_unchecked<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand Down

8 changes: 6 additions & 2 deletions
library/std/src/thread/functions.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,11 @@ use crate::{io, panicking};
///
/// # Panics
///
/// Panics if the OS fails to create a thread; use [`Builder::spawn`]
/// to recover from such errors.
/// 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
/// called in the parent thread, but the returned functions will not be executed.
///
/// # Examples
///
Expand DownExpand Up@@ -120,6 +123,7 @@ use crate::{io, panicking};
/// [`channels`]: crate::sync::mpsc
/// [`join`]: JoinHandle::join
/// [`Err`]: crate::result::Result::Err
/// [`add_spawn_hook`]: crate::thread::add_spawn_hook
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
pub fn spawn<F, T>(f: F) -> JoinHandle<T>
Expand Down

17 changes: 17 additions & 0 deletions
library/std/src/thread/scoped.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -196,7 +196,13 @@ impl<'scope, 'env> Scope<'scope, 'env> {
 /// 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`],
 /// they will still be called in the parent thread, but the returned functions will
 /// not be executed.
 ///
 /// [`join`]: ScopedJoinHandle::join
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 /// [`spawn`]: crate::thread::spawn
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn<F, T>(&'scope self, f: F) -> ScopedJoinHandle<'scope, T>
 where
Expand All@@ -213,10 +219,18 @@ impl Builder {
 /// Unlike [`Scope::spawn`], this method yields an [`io::Result`] to
 /// capture any failure to create the thread at the OS level.
 ///
 /// Like [`Scope::spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// 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.
 ///
 /// # Example
 ///
 /// ```
Expand DownExpand Up@@ -252,6 +266,9 @@ impl Builder {
 /// a.push(4);
 /// assert_eq!(x, a.len());
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn_scoped<'scope, 'env, F, T>(
 self,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Documented thread hooks on panics and errors of thread spawning functions.#149927

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

AhoyISki
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


Documented thread hooks on panics and errors of thread spawning functions.
#149927
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
library/std/src/thread/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -160,10 +160,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
@nia-enia-eAug 28, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This should disambiguate the spawn being referred to (i.e. "like the free spawn function")
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Examples
 ///
 /// ```
Expand All@@ -178,8 +186,10 @@ impl Builder {
 /// handler.join().unwrap();
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "rust1", since = "1.0.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub fn spawn<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand DownExpand Up@@ -209,10 +219,18 @@ impl Builder {
 /// [`io::Result`] to capture any failure to create the thread at
 /// the OS level.
 ///
 /// Like [`spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// Panics if a thread name was set and it contained null bytes.
 ///
 /// Unlike the [`spawn`] free function, if it panics for this reason, the
 /// parent thread functions added by [`add_spawn_hook`] will _not_ be called.
 ///
 /// # Safety
 ///
 /// The caller has to ensure that the spawned thread does not outlive any
Expand DownExpand Up@@ -249,6 +267,7 @@ impl Builder {
 ///
 /// [`thread::spawn`]: super::spawn
 /// [`spawn`]: super::spawn
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "thread_spawn_unchecked", since = "1.82.0")]
 #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 pub unsafe fn spawn_unchecked<F, T>(self, f: F) -> io::Result<JoinHandle<T>>
Expand Down

8 changes: 6 additions & 2 deletions
library/std/src/thread/functions.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,11 @@ use crate::{io, panicking};
///
/// # Panics
///
/// Panics if the OS fails to create a thread; use [`Builder::spawn`]
/// to recover from such errors.
/// 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
/// called in the parent thread, but the returned functions will not be executed.
///
/// # Examples
///
Expand DownExpand Up@@ -120,6 +123,7 @@ use crate::{io, panicking};
/// [`channels`]: crate::sync::mpsc
/// [`join`]: JoinHandle::join
/// [`Err`]: crate::result::Result::Err
/// [`add_spawn_hook`]: crate::thread::add_spawn_hook
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
pub fn spawn<F, T>(f: F) -> JoinHandle<T>
Expand Down

17 changes: 17 additions & 0 deletions
library/std/src/thread/scoped.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -196,7 +196,13 @@ impl<'scope, 'env> Scope<'scope, 'env> {
 /// 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`],
 /// they will still be called in the parent thread, but the returned functions will
 /// not be executed.
 ///
 /// [`join`]: ScopedJoinHandle::join
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 /// [`spawn`]: crate::thread::spawn
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn<F, T>(&'scope self, f: F) -> ScopedJoinHandle<'scope, T>
 where
Expand All@@ -213,10 +219,18 @@ impl Builder {
 /// Unlike [`Scope::spawn`], this method yields an [`io::Result`] to
 /// capture any failure to create the thread at the OS level.
 ///
 /// Like [`Scope::spawn`], this method will still call the main thread functions
 /// added by [`add_spawn_hook`] (unless [`Builder::no_hooks`] was called),
 /// but won't execute the returned functions if thread creation fails at the
 /// OS level.
 ///
 /// # Panics
 ///
 /// 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.
 ///
 /// # Example
 ///
 /// ```
Expand DownExpand Up@@ -252,6 +266,9 @@ impl Builder {
 /// a.push(4);
 /// assert_eq!(x, a.len());
 /// ```
 ///
 /// [`io::Result`]: crate::io::Result
 /// [`add_spawn_hook`]: crate::thread::add_spawn_hook
 #[stable(feature = "scoped_threads", since = "1.63.0")]
 pub fn spawn_scoped<'scope, 'env, F, T>(
 self,
Expand Down
Loading