tokio-rs/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2026-08-21 00:00:10 +02:00
Code Issues Packages Projects Releases Wiki Activity

task: clarify the behavior of several spawn_local methods (#7669)

Browse Source
This commit is contained in:
Mattia Pitossi
2025-10-12 10:46:23 +08:00
committed by GitHub
parent e7e02fcf0f
commit c1fa25f300
5 changed files with 24 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio-util/src/task/join_queue.rs
+5 -4
View File
@@ -88,9 +88,9 @@ impl<T> JoinQueue<T> {
self.push_back(handle.spawn(task))
}
/// Spawn the provided task on the current [`LocalSet`] and store it in this
/// [`JoinQueue`], returning an [`AbortHandle`] that can be used to remotely
/// cancel the task.
/// Spawn the provided task on the current [`LocalSet`] or [`LocalRuntime`]
/// and store it in this [`JoinQueue`], returning an [`AbortHandle`] that
/// can be used to remotely cancel the task.
///
/// The provided future will start running in the background immediately
/// when this method is called, even if you don't await anything on this
@@ -98,9 +98,10 @@ impl<T> JoinQueue<T> {
///
/// # Panics
///
/// This method panics if it is called outside of a `LocalSet`.
/// This method panics if it is called outside of a `LocalSet` or `LocalRuntime`.
///
/// [`LocalSet`]: tokio::task::LocalSet
/// [`LocalRuntime`]: tokio::runtime::LocalRuntime
/// [`AbortHandle`]: tokio::task::AbortHandle
#[track_caller]
pub fn spawn_local<F>(&mut self, task: F) -> AbortHandle