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

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
+7 -1
View File
@@ -401,11 +401,17 @@ impl TaskTracker {
handle.spawn(self.track_future(task))
}
/// Spawn the provided future on the current [`LocalSet`], and track it in this `TaskTracker`.
/// Spawn the provided future on the current [`LocalSet`] or [`LocalRuntime`]
/// and track it in this `TaskTracker`.
///
/// This is equivalent to `tokio::task::spawn_local(tracker.track_future(task))`.
///
/// # Panics
///
/// This method panics if it is called outside of a `LocalSet` or `LocalRuntime`.
///
/// [`LocalSet`]: tokio::task::LocalSet
/// [`LocalRuntime`]: tokio::runtime::LocalRuntime
#[inline]
#[track_caller]
#[cfg(feature = "rt")]