Structure

AsyncStream.Continuation

A mechanism to interface between synchronous code and an asynchronous stream.

Declaration 宣言 

struct AsyncStream<Element>.Continuation

Overview 概要

The closure you provide to the AsyncStream in init(_:bufferingPolicy:_:) receives an instance of this type when invoked. Use this continuation to provide elements to the stream by calling one of the yield methods, then terminate the stream normally by calling the finish() method.

Topics 話題

Producing Elements

func yield(Element) -> AsyncStream<Element>.Continuation.YieldResult
Resume the task awaiting the next iteration point by having it return nomally from its suspension point with a given element.
func yield(with: Result<Element, Never>) -> AsyncStream<Element>.Continuation.YieldResult
Resume the task awaiting the next iteration point by having it return normally from its suspension point with a given result’s success value.
func yield() -> AsyncStream<Element>.Continuation.YieldResult
Resume the task awaiting the next iteration point by having it return normally from its suspension point.
enum AsyncStream.Continuation.YieldResult
A type that indicates the result of yielding a value to a client, by way of the continuation.

Finishing the Stream

func finish()
Resume the task awaiting the next iteration point by having it return nil, which signifies the end of the iteration.

Handling Termination

var onTermination: (@Sendable (AsyncStream<Element>.Continuation.Termination) -> Void)?
A callback to invoke when canceling iteration of an asynchronous stream.
enum AsyncStream.Continuation.Termination
A type that indicates how the stream terminated.

Enumerations 列挙

enum AsyncStream.Continuation.BufferingPolicy
A strategy that handles exhaustion of a buffer’s capacity. ある戦略、それはあるバッファのもつ容量の枯渇を取り扱います。

Relationships 関係

Conforms To 次に準拠

See Also 参照

Creating a Continuation-Based Stream

init(Element.Type, bufferingPolicy: AsyncStream<Element>.Continuation.BufferingPolicy, (AsyncStream<Element>.Continuation) -> Void)
Constructs an asynchronous stream for an element type, using the specified buffering policy and element-producing closure.
enum AsyncStream.Continuation.BufferingPolicy
A strategy that handles exhaustion of a buffer’s capacity. ある戦略、それはあるバッファのもつ容量の枯渇を取り扱います。