Contents

CheckedContinuation

A mechanism to interface between synchronous and asynchronous code, logging correctness violations.

Declaration

struct CheckedContinuation<T, E> where E : Error

Overview

A continuation is an opaque representation of program state. To create a continuation in asynchronous code, call the withCheckedContinuation(isolation:function:_:) or withCheckedThrowingContinuation(isolation:function:_:) function. To resume the asynchronous task, call the resume(returning:), resume(throwing:), resume(with:), or resume() method.

Resuming from a continuation more than once is undefined behavior. Never resuming leaves the task in a suspended state indefinitely, and leaks any associated resources. CheckedContinuation logs a message if either of these invariants is violated.

CheckedContinuation performs runtime checks for missing or multiple resume operations. UnsafeContinuation avoids enforcing these invariants at runtime because it aims to be a low-overhead mechanism for interfacing Swift tasks with event loops, delegate methods, callbacks, and other non-async scheduling mechanisms. However, during development, the ability to verify that the invariants are being upheld in testing is important. Because both types have the same interface, you can replace one with the other in most circumstances, without making other changes.

Topics

Initializers

Instance Methods

See Also

Continuations