Skip to content

0009-async.md

Latest commit

 

History

History
48 lines (33 loc) · 1.74 KB

0009-async.md

File metadata and controls

48 lines (33 loc) · 1.74 KB
Raw

AsyncSyncSequence

Introduction

AsyncSyncSequence converts a non-asynchronous sequence into an asynchronous one.

This operation is available for all Sequence types.

let numbers = [1, 2, 3, 4].async
let characters = "abcde".async

This transformation can be useful to test operations specifically available on AsyncSequence but also is useful to combine with other AsyncSequence types to provide well known sources of data.

The .async property returns an AsyncSyncSequence that is generic upon the base Sequence it was constructed from.

extension Sequence {
  public var async: AsyncSyncSequence<Self> { get }
}

public struct AsyncSyncSequence<Base: Sequence>: AsyncSequence {
  ...
}

extension AsyncSyncSequence: Sendable where Base: Sendable { }
extension AsyncSyncSequence.Iterator: Sendable where Base.Iterator: Sendable { }

Naming

This property's and type's name match the naming approaches in the Swift standard library. The property is named with a succinct name in inspiration from .lazy, and the type is named in reference to the lazy behavior of the constructed AsyncSequence.

Effect on API resilience

AsyncSyncSequence has a trivial implementation and is marked as @frozen and @inlinable. This removes the ability of this type and functions to be ABI resilient boundaries at the benefit of being highly optimizable.