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 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
|
//===----------------------------------------------------------------------===//
//
// 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 {
/// Returns an asynchronous sequence, containing the initial, consecutive
/// elements of the base sequence that satisfy the given error-throwing
/// predicate.
///
/// Use `prefix(while:)` to produce values while elements from the base
/// sequence meet a condition you specify. The modified sequence ends when
/// the predicate closure returns `false` or throws an error.
///
/// In this example, an asynchronous sequence called `Counter` produces `Int`
/// values from `1` to `10`. The `prefix(_:)` method causes the modified
/// sequence to pass through values less than `8`, but throws an
/// error when it receives a value that's divisible by `5`:
///
/// do {
/// let stream = try Counter(howHigh: 10)
/// .prefix {
/// if $0 % 5 == 0 {
/// throw MyError()
/// }
/// return $0 < 8
/// }
/// for try await number in stream {
/// print(number, terminator: " ")
/// }
/// } catch {
/// print("Error: \(error)")
/// }
/// // Prints "1 2 3 4 Error: MyError() "
///
/// - Parameter predicate: A error-throwing closure that takes an element of
/// the asynchronous sequence as its argument and returns a Boolean value
/// that indicates whether to include the element in the modified sequence.
/// - Returns: An asynchronous sequence that contains, in order, the elements
/// of the base sequence that satisfy the given predicate. If the predicate
/// throws an error, the sequence contains only values produced prior to
/// the error.
@preconcurrency
@inlinable
public __consuming func prefix(
while predicate: @Sendable @escaping (Element) async throws -> Bool
) rethrows -> AsyncThrowingPrefixWhileSequence<Self> {
return AsyncThrowingPrefixWhileSequence(self, predicate: predicate)
}
}
/// An asynchronous sequence, containing the initial, consecutive
/// elements of the base sequence that satisfy the given error-throwing
/// predicate.
@available(SwiftStdlib 5.1, *)
public struct AsyncThrowingPrefixWhileSequence<Base: AsyncSequence> {
@usableFromInline
let base: Base
@usableFromInline
let predicate: (Base.Element) async throws -> Bool
@usableFromInline
init(
_ base: Base,
predicate: @escaping (Base.Element) async throws -> Bool
) {
self.base = base
self.predicate = predicate
}
}
@available(SwiftStdlib 5.1, *)
extension AsyncThrowingPrefixWhileSequence: AsyncSequence {
/// The type of element produced by this asynchronous sequence.
///
/// The prefix-while sequence produces whatever type of element its base
/// iterator produces.
public typealias Element = Base.Element
/// The type of error produced by this asynchronous sequence.
///
/// The prefix-while sequence produces errors from either the base
/// sequence or the filtering closure.
public typealias Failure = any Error
/// The type of iterator that produces elements of the sequence.
public typealias AsyncIterator = Iterator
/// The iterator that produces elements of the prefix-while sequence.
public struct Iterator: AsyncIteratorProtocol {
@usableFromInline
var predicateHasFailed = false
@usableFromInline
var baseIterator: Base.AsyncIterator
@usableFromInline
let predicate: (Base.Element) async throws -> Bool
@usableFromInline
init(
_ baseIterator: Base.AsyncIterator,
predicate: @escaping (Base.Element) async throws -> Bool
) {
self.baseIterator = baseIterator
self.predicate = predicate
}
/// Produces the next element in the prefix-while sequence.
///
/// If the predicate hasn't failed yet, this method gets the next element
/// from the base sequence and calls the predicate with it. If this call
/// succeeds, this method passes along the element. Otherwise, it returns
/// `nil`, ending the sequence. If calling the predicate closure throws an
/// error, the sequence ends and `next()` rethrows the error.
@inlinable
public mutating func next() async throws -> Base.Element? {
if !predicateHasFailed, let nextElement = try await baseIterator.next() {
do {
if try await predicate(nextElement) {
return nextElement
} else {
predicateHasFailed = true
}
} catch {
predicateHasFailed = true
throw error
}
}
return nil
}
/// Produces the next element in the prefix-while sequence.
///
/// If the predicate hasn't failed yet, this method gets the next element
/// from the base sequence and calls the predicate with it. If this call
/// succeeds, this method passes along the element. Otherwise, it returns
/// `nil`, ending the sequence. If calling the predicate closure throws an
/// error, the sequence ends and `next(isolation:)` rethrows the error.
@available(SwiftStdlib 6.0, *)
@inlinable
public mutating func next(isolation actor: isolated (any Actor)?) async throws(Failure) -> Base.Element? {
if !predicateHasFailed, let nextElement = try await baseIterator.next(isolation: actor) {
do {
if try await predicate(nextElement) {
return nextElement
} else {
predicateHasFailed = true
}
} catch {
predicateHasFailed = true
throw error
}
}
return nil
}
}
@inlinable
public __consuming func makeAsyncIterator() -> Iterator {
return Iterator(base.makeAsyncIterator(), predicate: predicate)
}
}
@available(SwiftStdlib 5.1, *)
extension AsyncThrowingPrefixWhileSequence: @unchecked Sendable
where Base: Sendable,
Base.Element: Sendable { }
@available(SwiftStdlib 5.1, *)
extension AsyncThrowingPrefixWhileSequence.Iterator: @unchecked Sendable
where Base.AsyncIterator: Sendable,
Base.Element: Sendable { }
|