Skip to content
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

Jump to bottom

task: add cancel safety docs to JoinHandle #4901

Merged
merged 2 commits into from Aug 11, 2022
Merged

task: add cancel safety docs to JoinHandle #4901

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed02873
task: add cancel safety docs to `JoinHandle`
Darksonn Aug 11, 2022
f200ff7
rustfmt
Darksonn Aug 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions tokio/src/runtime/task/join.rs
View file
Open in desktop
Expand Up @@ -20,6 +20,15 @@ cfg_rt! {
/// This `struct` is created by the [`task::spawn`] and [`task::spawn_blocking`]
/// functions.
///
/// # Cancel safety
///
/// The `&mut JoinHandle<T>` type is cancel safe. If it is used as the event
/// in a `tokio::select!` statement and some other branch completes first,
/// then it is guaranteed that the output of the task is not lost.
///
/// If a `JoinHandle` is dropped, then the task continues running in the
/// background and its return value is lost.
///
/// # Examples
///
/// Creation from [`task::spawn`]:
Expand Down