A type that indicates the result of yielding a value to a client, by way of the continuation.
enum YieldResultThe various yield methods of AsyncThrowingStream.Continuation return this type to indicate the success or failure of yielding an element to the continuation.
import _Concurrencystruct ContinuationA mechanism to interface between synchronous code and an asynchronous stream.
struct AsyncThrowingStream<Element, Failure> where Failure : ErrorAn asynchronous sequence generated from an error-throwing closure that calls a continuation to produce new elements.
case dropped(Element)The stream didn’t enqueue the element because the buffer was full.
case enqueued(remaining: Int)The stream successfully enqueued the element.
case terminatedThe stream didn’t enqueue the element because the stream was in a terminal state.
var onTermination: ((AsyncThrowingStream<Element, Failure>.Continuation.Termination) -> Void)? { get nonmutating set }A callback to invoke when canceling iteration of an asynchronous stream.
func finish(throwing error: Failure? = nil) Resume the task awaiting the next iteration point by having it return nil, which signifies the end of the iteration.
@discardableResult func yield(_ value: sending Element) -> AsyncThrowingStream<Element, Failure>.Continuation.YieldResult Resume the task awaiting the next iteration point by having it return normally from its suspension point with a given element.
enum BufferingPolicyA strategy that handles exhaustion of a buffer’s capacity.
enum TerminationA type that indicates how the stream terminated.
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol SendableA thread-safe type whose values can be shared across arbitrary concurrent contexts without introducing a risk of data races. Values of the type may have no shared mutable state, or they may protect that state with a lock or by forcing it to only be accessed from a specific actor.
protocol Escapableprotocol Error : SendableA type representing an error value that can be thrown.