Skip to content

Document withTaskCancellationHandler parameters and at-most-once semantics #85126

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

Merged
merged 2 commits into from
Oct 27, 2025
Merged

Document withTaskCancellationHandler parameters and at-most-once semantics #85126

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3994ec
Document parameters and at-most-once semantics
amartini51 Oct 24, 2025
09bbcdd
Include at-most-once
amartini51 Oct 24, 2025
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
7 changes: 7 additions & 0 deletions stdlib/public/Concurrency/TaskCancellation.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ import Swift
/// Execute an operation with a cancellation handler that's immediately
/// invoked if the current task is canceled.
///
/// - Parameters:
/// - operation: The operation to perform.
/// - handler: A closure to execute on cancellation.
/// If the task is canceled, this closure is called at most once;
/// otherwise, it isn't called.
/// - isolation: The actor that the operation and cancellation handler are isolated to.
///
/// This differs from the operation cooperatively checking for cancellation
/// and reacting to it in that the cancellation handler is _always_ and
/// _immediately_ invoked when the task is canceled. For example, even if the
Expand Down