1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2021 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Swift
@available(SwiftStdlib 5.1, *)
extension AsyncSequence {
/// Creates an asynchronous sequence that maps the given closure over the
/// asynchronous sequence’s elements.
///
/// Use the `map(_:)` method to transform every element received from a base
/// asynchronous sequence. Typically, you use this to transform from one type
/// of element to another.
///
/// In this example, an asynchronous sequence called `Counter` produces `Int`
/// values from `1` to `5`. The closure provided to the `map(_:)` method
/// takes each `Int` and looks up a corresponding `String` from a
/// `romanNumeralDict` dictionary. This means the outer `for await in` loop
/// iterates over `String` instances instead of the underlying `Int` values
/// that `Counter` produces:
///
/// let romanNumeralDict: [Int: String] =
/// [1: "I", 2: "II", 3: "III", 5: "V"]
///
/// let stream = Counter(howHigh: 5)
/// .map { romanNumeralDict[$0] ?? "(unknown)" }
/// for await numeral in stream {
/// print(numeral, terminator: " ")
/// }
/// // Prints "I II III (unknown) V "
///
/// - Parameter transform: A mapping closure. `transform` accepts an element
/// of this sequence as its parameter and returns a transformed value of the
/// same or of a different type.
/// - Returns: An asynchronous sequence that contains, in order, the elements
/// produced by the `transform` closure.
@preconcurrency
@inlinable
public __consuming func map<Transformed>(
_ transform: @Sendable @escaping (Element) async -> Transformed
) -> AsyncMapSequence<Self, Transformed> {
return AsyncMapSequence(self, transform: transform)
}
}
/// An asynchronous sequence that maps the given closure over the asynchronous
/// sequence’s elements.
@available(SwiftStdlib 5.1, *)
public struct AsyncMapSequence<Base: AsyncSequence, Transformed> {
@usableFromInline
let base: Base
@usableFromInline
let transform: (Base.Element) async -> Transformed
@usableFromInline
init(
_ base: Base,
transform: @escaping (Base.Element) async -> Transformed
) {
self.base = base
self.transform = transform
}
}
@available(SwiftStdlib 5.1, *)
extension AsyncMapSequence: AsyncSequence {
/// The type of element produced by this asynchronous sequence.
///
/// The map sequence produces whatever type of element its transforming
/// closure produces.
public typealias Element = Transformed
/// The type of the error that can be produced by the sequence.
///
/// The map sequence produces whatever type of error its
/// base sequence does.
@available(SwiftStdlib 6.0, *)
public typealias Failure = Base.Failure
/// The type of iterator that produces elements of the sequence.
public typealias AsyncIterator = Iterator
/// The iterator that produces elements of the map sequence.
public struct Iterator: AsyncIteratorProtocol {
// FIXME: Remove when $AssociatedTypeImplements is no longer needed
@available(SwiftStdlib 6.0, *)
public typealias Failure = Base.Failure
@usableFromInline
var baseIterator: Base.AsyncIterator
@usableFromInline
let transform: (Base.Element) async -> Transformed
@usableFromInline
init(
_ baseIterator: Base.AsyncIterator,
transform: @escaping (Base.Element) async -> Transformed
) {
self.baseIterator = baseIterator
self.transform = transform
}
/// Produces the next element in the map sequence.
///
/// This iterator calls `next()` on its base iterator; if this call returns
/// `nil`, `next()` returns `nil`. Otherwise, `next()` returns the result of
/// calling the transforming closure on the received element.
@inlinable
public mutating func next() async rethrows -> Transformed? {
guard let element = try await baseIterator.next() else {
return nil
}
return await transform(element)
}
/// Produces the next element in the map sequence.
///
/// This iterator calls `next(isolation:)` on its base iterator; if this
/// call returns `nil`, `next(isolation:)` returns `nil`. Otherwise,
/// `next(isolation:)` returns the result of calling the transforming
/// closure on the received element.
@available(SwiftStdlib 6.0, *)
@inlinable
public mutating func next(isolation actor: isolated (any Actor)?) async throws(Failure) -> Transformed? {
guard let element = try await baseIterator.next(isolation: actor) else {
return nil
}
return await transform(element)
}
}
@inlinable
public __consuming func makeAsyncIterator() -> Iterator {
return Iterator(base.makeAsyncIterator(), transform: transform)
}
}
@available(SwiftStdlib 5.1, *)
extension AsyncMapSequence: @unchecked Sendable
where Base: Sendable,
Base.Element: Sendable,
Transformed: Sendable { }
@available(SwiftStdlib 5.1, *)
extension AsyncMapSequence.Iterator: @unchecked Sendable
where Base.AsyncIterator: Sendable,
Base.Element: Sendable,
Transformed: Sendable { }
|
