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 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
|
//===----------------------------------------------------------------------===//
//
// 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 {
/// Omits elements from the base sequence until a given error-throwing closure
/// returns false, after which it passes through all remaining elements.
///
/// Use `drop(while:)` to omit elements from an asynchronous sequence until
/// the element received meets a condition you specify. If the closure you
/// provide throws an error, the sequence produces no elements and throws
/// the error instead.
///
/// In this example, an asynchronous sequence called `Counter` produces `Int`
/// values from `1` to `10`. The predicate passed to the `drop(while:)`
/// method throws an error if it encounters an even number, and otherwise
/// returns `true` while it receives elements less than `5`. Because the
/// predicate throws when it receives `2` from the base sequence, this example
/// throws without ever printing anything.
///
/// do {
/// let stream = Counter(howHigh: 10)
/// .drop {
/// if $0 % 2 == 0 {
/// throw EvenError()
/// }
/// return $0 < 5
/// }
/// for try await number in stream {
/// print(number)
/// }
/// } catch {
/// print(error)
/// }
/// // Prints "EvenError()"
///
/// After the predicate returns `false`, the sequence never executes it again,
/// and from then on the sequence passes through elements from its underlying
/// sequence. A predicate that throws an error also never executes again.
///
/// - Parameter predicate: An error-throwing closure that takes an element as
/// a parameter and returns a Boolean value indicating whether to drop the
/// element from the modified sequence.
/// - Returns: An asynchronous sequence that skips over values until the
/// provided closure returns `false` or throws an error.
@preconcurrency
@inlinable
public __consuming func drop(
while predicate: @Sendable @escaping (Element) async throws -> Bool
) -> AsyncThrowingDropWhileSequence<Self> {
AsyncThrowingDropWhileSequence(self, predicate: predicate)
}
}
/// An asynchronous sequence which omits elements from the base sequence until a
/// given error-throwing closure returns false, after which it passes through
/// all remaining elements.
@available(SwiftStdlib 5.1, *)
public struct AsyncThrowingDropWhileSequence<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 AsyncThrowingDropWhileSequence: AsyncSequence {
/// The type of element produced by this asynchronous sequence.
///
/// The drop-while sequence produces whatever type of element its base
/// sequence produces.
public typealias Element = Base.Element
/// The type of element produced by this asynchronous sequence.
///
/// The drop-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 drop-while sequence.
public struct Iterator: AsyncIteratorProtocol {
@usableFromInline
var baseIterator: Base.AsyncIterator
@usableFromInline
let predicate: (Base.Element) async throws -> Bool
@usableFromInline
var finished = false
@usableFromInline
var doneDropping = false
@usableFromInline
init(
_ baseIterator: Base.AsyncIterator,
predicate: @escaping (Base.Element) async throws -> Bool
) {
self.baseIterator = baseIterator
self.predicate = predicate
}
/// Produces the next element in the drop-while sequence.
///
/// This iterator calls `next()` on its base iterator and evaluates the
/// result with the `predicate` closure. As long as the predicate returns
/// `true`, this method returns `nil`. After the predicate returns `false`,
/// for a value received from the base iterator, this method returns that
/// value. After that, the iterator returns values received from its
/// base iterator as-is, and never executes the predicate closure again.
/// If calling the closure throws an error, the sequence ends and `next()`
/// rethrows the error.
@inlinable
public mutating func next() async throws -> Base.Element? {
while !finished && !doneDropping {
guard let element = try await baseIterator.next() else {
return nil
}
do {
if try await predicate(element) == false {
doneDropping = true
return element
}
} catch {
finished = true
throw error
}
}
guard !finished else {
return nil
}
return try await baseIterator.next()
}
/// Produces the next element in the drop-while sequence.
///
/// This iterator calls `next(isolation:)` on its base iterator and
/// evaluates the result with the `predicate` closure. As long as the
/// predicate returns `true`, this method returns `nil`. After the predicate
/// returns `false`, for a value received from the base iterator, this
/// method returns that value. After that, the iterator returns values
/// received from its base iterator as-is, and never executes the predicate
/// closure again. If calling the 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? {
while !finished && !doneDropping {
guard let element = try await baseIterator.next(isolation: actor) else {
return nil
}
do {
if try await predicate(element) == false {
doneDropping = true
return element
}
} catch {
finished = true
throw error
}
}
guard !finished else {
return nil
}
return try await baseIterator.next(isolation: actor)
}
}
@inlinable
public __consuming func makeAsyncIterator() -> Iterator {
return Iterator(base.makeAsyncIterator(), predicate: predicate)
}
}
@available(SwiftStdlib 5.1, *)
extension AsyncThrowingDropWhileSequence: @unchecked Sendable
where Base: Sendable,
Base.Element: Sendable { }
@available(SwiftStdlib 5.1, *)
extension AsyncThrowingDropWhileSequence.Iterator: @unchecked Sendable
where Base.AsyncIterator: Sendable,
Base.Element: Sendable { }
|