File: AsyncStreamController.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (61 lines) | stat: -rw-r--r-- 2,264 bytes parent folder | download
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2025 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

/// Helper to provide convenient access to an AsyncStream's continuation, which is one of the few in Swift Concurrency allowed to escape.
public final class AsyncStreamController<Element: Sendable, Failure>: Sendable where Failure: Error {
    private let continuation: AsyncStream<Element>.Continuation
    fileprivate let task: Task<Void, Failure>

    init(continuation: AsyncStream<Element>.Continuation, task: Task<Void, Failure>) {
        self.continuation = continuation
        self.task = task
    }

    deinit {
        invalidate()
    }

    @discardableResult public func yield(_ value: Element) -> AsyncStream<Element>.Continuation.YieldResult {
        continuation.yield(value)
    }

    public func finish() {
        continuation.finish()
    }

    public func invalidate() {
        finish()
        task.cancel()
    }
}

extension AsyncStreamController where Failure == any Error {
    public convenience init(priority: TaskPriority? = nil, _ task: @Sendable @escaping (AsyncStream<Element>) async throws -> Void) {
        let (stream, continuation) = AsyncStream<Element>.makeStream()
        self.init(continuation: continuation, task: Task<Void, Failure>(priority: priority) { try await task(stream) })
    }

    public func wait() async throws {
        try await task.value
    }
}

extension AsyncStreamController where Failure == Never {
    public convenience init(priority: TaskPriority? = nil, _ task: @Sendable @escaping (AsyncStream<Element>) async -> Void) {
        let (stream, continuation) = AsyncStream<Element>.makeStream()
        self.init(continuation: continuation, task: Task<Void, Failure>(priority: priority) { await task(stream) })
    }

    public func wait() async {
        await task.value
    }
}