File: AsyncSequence.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 (107 lines) | stat: -rw-r--r-- 4,288 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
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
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

import SWBUtil

extension FixedWidthInteger {
    public init(protocolEndian value: Self) {
        self.init(littleEndian: value)
    }

    public var protocolEndian: Self {
        littleEndian
    }
}

/// An async sequence whose elements are a Swift Build IPC message - a tuple of a channel ID and a sequence of bytes constituting the message contents.
public struct AsyncIPCMessageSequence<Base: AsyncSequence>: AsyncSequence where Base.Element == UInt8 {
    public typealias Element = (UInt64, [UInt8])

    var base: Base

    fileprivate struct EOFError: Error {
    }

    public struct AsyncIterator: AsyncIteratorProtocol {
        var _base: Base.AsyncIterator

        internal init(underlyingIterator: Base.AsyncIterator) {
            _base = underlyingIterator
        }

        public mutating func next() async throws -> Element? {
            if #available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *) {
                return try await next(isolation: nil)
            } else {
                // The message header consist of a 64-bit channel number followed by a 32-bit payload size.
                guard let channelID = try await _base.nextInt().map(UInt64.init(protocolEndian:)) else {
                    // If we reach EOF here it's expected as there are simply no more messages
                    return nil
                }

                guard let payloadSize = try await _base.nextInt().map(Int32.init(protocolEndian:)) else {
                    // We already started reading a message, if we fail here it's unexpectedly EOF
                    throw EOFError()
                }

                // Int32 -> Int can never fail on any architecture
                guard let payloadBytes = try await _base.next(count: Int(payloadSize)) else {
                    // We already started reading a message, if we fail here it's unexpectedly EOF
                    throw EOFError()
                }

                return (channelID, payloadBytes)
            }
        }

        @available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
        public mutating func next(isolation actor: isolated (any Actor)?) async throws(any Error) -> Element? {
            // The message header consist of a 64-bit channel number followed by a 32-bit payload size.
            guard let channelID = try await _base.nextInt(isolation: actor).map(UInt64.init(protocolEndian:)) else {
                // If we reach EOF here it's expected as there are simply no more messages
                return nil
            }

            guard let payloadSize = try await _base.nextInt(isolation: actor).map(Int32.init(protocolEndian:)) else {
                // We already started reading a message, if we fail here it's unexpectedly EOF
                throw EOFError()
            }

            // Int32 -> Int can never fail on any architecture
            guard let payloadBytes = try await _base.next(count: Int(payloadSize), isolation: actor) else {
                // We already started reading a message, if we fail here it's unexpectedly EOF
                throw EOFError()
            }

            return (channelID, payloadBytes)
        }
    }

    public func makeAsyncIterator() -> AsyncIterator {
        return AsyncIterator(underlyingIterator: base.makeAsyncIterator())
    }

    internal init(underlyingSequence: Base) {
        base = underlyingSequence
    }
}

extension AsyncSequence where Self.Element == UInt8 {
    public var ipcMessages: AsyncIPCMessageSequence<Self> {
        AsyncIPCMessageSequence(underlyingSequence: self)
    }
}

extension AsyncIPCMessageSequence: Sendable where Base: Sendable { }

@available(*, unavailable)
extension AsyncIPCMessageSequence.AsyncIterator: Sendable { }