Instance Method インスタンスメソッド

cancel()

Indicates that the task should stop running.

Declaration 宣言 

func cancel()

Discussion 解説

Task cancellation is cooperative: a task that supports cancellation checks whether it has been canceled at various points during its work.

Calling this method on a task that doesn’t support cancellation has no effect. Likewise, if the task has already run past the last point where it would stop early, calling this method has no effect.

See Also 参照

Canceling Tasks タスクの取り消し

struct CancellationError
An error that indicates a task was canceled.
var isCancelled: Bool
A Boolean value that indicates whether the task should stop executing.
static var isCancelled: Bool
A Boolean value that indicates whether the task should stop executing.
Available when Success is Never and Failure is Never. SuccessがNeverであるそしてFailureがNeverである時に利用可能です。
static func checkCancellation()
Throws an error if the task was canceled.
Available when Success is Never and Failure is Never. SuccessがNeverであるそしてFailureがNeverである時に利用可能です。
func withTaskCancellationHandler<T>(operation: () -> T, onCancel: @Sendable () -> Void) -> T
Execute an operation with a cancellation handler that’s immediately invoked if the current task is canceled. 現在のタスクが取り消されるならば直ちに発動されるある取り消しハンドラを備えた操作を遂行します。
func withTaskCancellationHandler<T>(handler: @Sendable () -> Void, operation: () -> T) -> T
Execute an operation with a cancellation handler that’s immediately invoked if the current task is canceled. 現在のタスクが取り消されるならば直ちに発動されるある取り消しハンドラを備えた操作を遂行します。

Related Documentation 関連文書

Task.checkCancellation()