Swift Package IndexBuild Information
Successful build of AsyncSequenceReader, reference main (542db2), with Swift 6.0 for macOS (SPM) on 2 Dec 2024 22:29:46 UTC.
Swift 6 data race errors: 0
Build Command
env DEVELOPER_DIR=/Applications/Xcode-16.1.0.app xcrun swift build --arch arm64 -Xswiftc -Xfrontend -Xswiftc -stats-output-dir -Xswiftc -Xfrontend -Xswiftc .statsBuild Log
========================================
RunAll
========================================
Builder version: 4.58.3
Interrupt handler set up.
========================================
Checkout
========================================
Clone URL: https://github.com/mochidev/AsyncSequenceReader.git
Reference: main
Initialized empty Git repository in /Users/admin/builder/spi-builder-workspace/.git/
From https://github.com/mochidev/AsyncSequenceReader
* branch main -> FETCH_HEAD
* [new branch] main -> origin/main
HEAD is now at 542db2c Updated readme suggested version
Cloned https://github.com/mochidev/AsyncSequenceReader.git
Revision (git rev-parse @):
542db2cabb0b34f3c8035d58b06510968bca4cf9
SPI manifest file found: $PWD/.spi.yml
SUCCESS checkout https://github.com/mochidev/AsyncSequenceReader.git at main
========================================
ResolveProductDependencies
========================================
Resolving dependencies ...
{
"identity": ".resolve-product-dependencies",
"name": "resolve-dependencies",
"url": "/Users/admin/builder/spi-builder-workspace/.resolve-product-dependencies",
"version": "unspecified",
"path": "/Users/admin/builder/spi-builder-workspace/.resolve-product-dependencies",
"dependencies": [
{
"identity": "asyncsequencereader",
"name": "AsyncSequenceReader",
"url": "https://github.com/mochidev/AsyncSequenceReader.git",
"version": "unspecified",
"path": "/Users/admin/builder/spi-builder-workspace/.resolve-product-dependencies/.build/checkouts/AsyncSequenceReader",
"dependencies": [
]
}
]
}
Fetching https://github.com/mochidev/AsyncSequenceReader.git
[1/226] Fetching asyncsequencereader
Fetched https://github.com/mochidev/AsyncSequenceReader.git from cache (0.72s)
Creating working copy for https://github.com/mochidev/AsyncSequenceReader.git
Working copy of https://github.com/mochidev/AsyncSequenceReader.git resolved at main (542db2c)
warning: '.resolve-product-dependencies': dependency 'asyncsequencereader' is not used by any target
Found 0 product dependencies
========================================
Build
========================================
Selected platform: macosSpm
Swift version: 6.0
Building package at path: $PWD
https://github.com/mochidev/AsyncSequenceReader.git
{
"dependencies" : [
],
"manifest_display_name" : "AsyncSequenceReader",
"name" : "AsyncSequenceReader",
"path" : "/Users/admin/builder/spi-builder-workspace",
"platforms" : [
{
"name" : "macos",
"version" : "10.15"
},
{
"name" : "ios",
"version" : "13.0"
},
{
"name" : "tvos",
"version" : "13.0"
},
{
"name" : "watchos",
"version" : "6.0"
}
],
"products" : [
{
"name" : "AsyncSequenceReader",
"targets" : [
"AsyncSequenceReader"
],
"type" : {
"library" : [
"automatic"
]
}
}
],
"targets" : [
{
"c99name" : "AsyncSequenceReaderTests",
"module_type" : "SwiftTarget",
"name" : "AsyncSequenceReaderTests",
"path" : "Tests/AsyncSequenceReaderTests",
"sources" : [
"AsyncBufferedIteratorTests.swift",
"AsyncIteratorMapSequenceTests.swift",
"AsyncReadUpToCountSequenceTests.swift",
"AsyncReadUpToElementsSequenceTests.swift",
"AsyncSequenceReaderTests.swift",
"TestSequence.swift"
],
"target_dependencies" : [
"AsyncSequenceReader"
],
"type" : "test"
},
{
"c99name" : "AsyncSequenceReader",
"module_type" : "SwiftTarget",
"name" : "AsyncSequenceReader",
"path" : "Sources/AsyncSequenceReader",
"product_memberships" : [
"AsyncSequenceReader"
],
"sources" : [
"AnyReadableSequence.swift",
"AsyncBufferedIterator.swift",
"AsyncIteratorMapSequence.swift",
"AsyncReadSequence.swift",
"AsyncReadUpToCountSequence.swift",
"AsyncReadUpToElementsSequence.swift",
"AsyncSequenceReader.swift",
"AsyncSequenceReaderError.swift"
],
"type" : "library"
}
],
"tools_version" : "6.0"
}
Running build ...
env DEVELOPER_DIR=/Applications/Xcode-16.1.0.app xcrun swift build --arch arm64 -Xswiftc -Xfrontend -Xswiftc -stats-output-dir -Xswiftc -Xfrontend -Xswiftc .stats
Building for debugging...
[0/2] Write sources
[1/2] Write swift-version--7754E27361AE5C74.txt
[3/11] Compiling AsyncSequenceReader AsyncSequenceReaderError.swift
[4/11] Compiling AsyncSequenceReader AsyncSequenceReader.swift
[5/11] Compiling AsyncSequenceReader AsyncReadUpToElementsSequence.swift
[6/11] Compiling AsyncSequenceReader AsyncReadUpToCountSequence.swift
[7/11] Compiling AsyncSequenceReader AsyncReadSequence.swift
[8/11] Compiling AsyncSequenceReader AnyReadableSequence.swift
[9/11] Emitting module AsyncSequenceReader
[10/11] Compiling AsyncSequenceReader AsyncBufferedIterator.swift
[11/11] Compiling AsyncSequenceReader AsyncIteratorMapSequence.swift
Build complete! (4.63s)
Build complete.
{
"dependencies" : [
],
"manifest_display_name" : "AsyncSequenceReader",
"name" : "AsyncSequenceReader",
"path" : "/Users/admin/builder/spi-builder-workspace",
"platforms" : [
{
"name" : "macos",
"version" : "10.15"
},
{
"name" : "ios",
"version" : "13.0"
},
{
"name" : "tvos",
"version" : "13.0"
},
{
"name" : "watchos",
"version" : "6.0"
}
],
"products" : [
{
"name" : "AsyncSequenceReader",
"targets" : [
"AsyncSequenceReader"
],
"type" : {
"library" : [
"automatic"
]
}
}
],
"targets" : [
{
"c99name" : "AsyncSequenceReaderTests",
"module_type" : "SwiftTarget",
"name" : "AsyncSequenceReaderTests",
"path" : "Tests/AsyncSequenceReaderTests",
"sources" : [
"AsyncBufferedIteratorTests.swift",
"AsyncIteratorMapSequenceTests.swift",
"AsyncReadUpToCountSequenceTests.swift",
"AsyncReadUpToElementsSequenceTests.swift",
"AsyncSequenceReaderTests.swift",
"TestSequence.swift"
],
"target_dependencies" : [
"AsyncSequenceReader"
],
"type" : "test"
},
{
"c99name" : "AsyncSequenceReader",
"module_type" : "SwiftTarget",
"name" : "AsyncSequenceReader",
"path" : "Sources/AsyncSequenceReader",
"product_memberships" : [
"AsyncSequenceReader"
],
"sources" : [
"AnyReadableSequence.swift",
"AsyncBufferedIterator.swift",
"AsyncIteratorMapSequence.swift",
"AsyncReadSequence.swift",
"AsyncReadUpToCountSequence.swift",
"AsyncReadUpToElementsSequence.swift",
"AsyncSequenceReader.swift",
"AsyncSequenceReaderError.swift"
],
"type" : "library"
}
],
"tools_version" : "6.0"
}
✅ Doc result (pending) reported
========================================
GenerateDocs
========================================
Generating docs at path: $PWD/.docs/mochidev/asyncsequencereader/main
Repository: mochidev/AsyncSequenceReader
Swift version used: 6.0
Target: AsyncSequenceReader
Initialized empty Git repository in /Users/admin/builder/spi-builder-workspace/swift-docc-render-artifact/.git/
From https://github.com/swiftlang/swift-docc-render-artifact
* branch 88815688627177b9716a01ca41da19397bd30e47 -> FETCH_HEAD
HEAD is now at 8881568 Update the artifact
Extracting symbol information for 'AsyncSequenceReader'...
Finished extracting symbol information for 'AsyncSequenceReader'. (0.52s)
Building documentation for 'AsyncSequenceReader'...
warning: 'AsyncIteratorProtocol' doesn't exist at '/AsyncSequenceReader/AsyncReadSequence'
--> ../AsyncReadSequence.swift:13:195-13:216
11 | /// An AsyncSequence subtype suitable for reading an existing iterator in place.
12 | ///
13 + /// Note that to conform to this protocol, your type must be a reference type. After iterating, you'll also likely want to copy the base iterator back into your starting iterator, as shown in ``AsyncIteratorProtocol/transform(with:readSequenceFactory:)``.
14 | public protocol AsyncReadSequence: AsyncSequence, AnyObject {
15 | associatedtype BaseIterator: AsyncIteratorProtocol where BaseIterator.Element == Element
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:34:21-34:33
32 | ///
33 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
34 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
35 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
36 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:34:21-34:33
32 | ///
33 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
34 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
35 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
36 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:34:21-34:33
32 | ///
33 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
34 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
35 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
36 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:34:21-34:33
32 | ///
33 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
34 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
35 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
36 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:34:21-34:33
32 | ///
33 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
34 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
35 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
36 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:34:21-34:33
32 | ///
33 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
34 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
35 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
36 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:34:21-34:33
32 | ///
33 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
34 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
35 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
36 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:34:21-34:33
32 | ///
33 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
34 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
35 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
36 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:65:21-65:33
63 | ///
64 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
65 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
66 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
67 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:65:21-65:33
63 | ///
64 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
65 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
66 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
67 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:65:21-65:33
63 | ///
64 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
65 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
66 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
67 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:65:21-65:33
63 | ///
64 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
65 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
66 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
67 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:65:21-65:33
63 | ///
64 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
65 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
66 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
67 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:65:21-65:33
63 | ///
64 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
65 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
66 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
67 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:65:21-65:33
63 | ///
64 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
65 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
66 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
67 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:65:21-65:33
63 | ///
64 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
65 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
66 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
67 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:113:21-113:33
111 | ///
112 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
113 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
114 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
115 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:113:21-113:33
111 | ///
112 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
113 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
114 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
115 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:113:21-113:33
111 | ///
112 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
113 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
114 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
115 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:113:21-113:33
111 | ///
112 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
113 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
114 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
115 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:113:21-113:33
111 | ///
112 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
113 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
114 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
115 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:113:21-113:33
111 | ///
112 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
113 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
114 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
115 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:113:21-113:33
111 | ///
112 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
113 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
114 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
115 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:113:21-113:33
111 | ///
112 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
113 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
114 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
115 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:144:21-144:33
142 | ///
143 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
144 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
145 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
146 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:144:21-144:33
142 | ///
143 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
144 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
145 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
146 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:144:21-144:33
142 | ///
143 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
144 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
145 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
146 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:144:21-144:33
142 | ///
143 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
144 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
145 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
146 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:144:21-144:33
142 | ///
143 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
144 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
145 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
146 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:144:21-144:33
142 | ///
143 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
144 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
145 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
146 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:144:21-144:33
142 | ///
143 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
144 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
145 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
146 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:144:21-144:33
142 | ///
143 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
144 + /// - Parameter throwsIfOver: The maximum amount of elements that will be read before an error is thrown if a termination is not detected.
| ╰─suggestion: Replace 'throwsIfOver' with 'maximumBufferSize'
145 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
146 | /// - Throws: `AsyncSequenceReaderError.terminationNotFound` if a complete byte sequence could not be returned by the time the sequence ended.
warning: Can't resolve 'Swift'
--> AsyncSequenceReader.md:3:78-3:98
1 | # ``AsyncSequenceReader``
2 |
3 + ``AsyncSequenceReader`` provides building blocks to easily consume Swift's ``/Swift/AsyncSequence``.
4 |
5 | ## What is ``AsyncSequenceReader``?
warning: Can't resolve 'Swift'
--> AsyncSequenceReader.md:9:15-9:35
7 | ``AsyncSequenceReader`` is a collection of building blocks to make it easy to read information and transform `AsyncSequence` into data types your app understands.
8 |
9 + Although an ``/Swift/AsyncSequence`` can be consumed via a `for await` loop, that isn't often the easiest way of consuming that data:
10 |
11 | ```swift
warning: Can't resolve 'Swift'
--> AsyncSequenceReader.md:59:308-59:328
57 | Note: Resist the urge to catch errors within an iterator map, as once a value is read, it will no longer be available.
58 |
59 + Returning an object will make it available to whoever is consuming the resulting sequence, preparing your closure to be called again for the next object. Do note that Your closure will not be called unless something consumes your `results` sequence, either via `for await`, or by using `.reduce` or other ``/Swift/AsyncSequence`` methods.
60 |
61 | Note: Do not copy the iterator to other methods without marking it as `inout`, since as a value type, a copy will be made, and further reads may become out of sync.
warning: 'throwsIfOver' doesn't exist at '/AsyncSequenceReader'
--> AsyncSequenceReader.md:107:14-107:26
105 | This is especially useful when scanning for strings or other known boundaries, allowing you get get an array of elements either including or excluding the terminator you specified.
106 |
107 + Note how a ``throwsIfOver`` parameter is necessary — this is to prevent un-bounded reads from running out of control. If the terminator is not detected, or your maximum element allowance has been reached, an ``AsyncSequenceReaderError/terminationNotFound`` error will be thrown.
108 |
109 | You can bypass the `throwsIfOver` parameter if you use a **sequence transform** instead, which may be a better option if your algorithm deals with large amounts of data. If you stop reading early, elements can still be read by subsequent requests, giving you more control over how to read your data.
warning: 'terminationNotFound' doesn't exist at '/AsyncSequenceReader/AsyncSequenceReaderError'
--> AsyncSequenceReader.md:107:238-107:257
105 | This is especially useful when scanning for strings or other known boundaries, allowing you get get an array of elements either including or excluding the terminator you specified.
106 |
107 + Note how a ``throwsIfOver`` parameter is necessary — this is to prevent un-bounded reads from running out of control. If the terminator is not detected, or your maximum element allowance has been reached, an ``AsyncSequenceReaderError/terminationNotFound`` error will be thrown.
| ╰─suggestion: Replace 'terminationNotFound' with 'terminationNotFound(maximum:actual:)'
108 |
109 | You can bypass the `throwsIfOver` parameter if you use a **sequence transform** instead, which may be a better option if your algorithm deals with large amounts of data. If you stop reading early, elements can still be read by subsequent requests, giving you more control over how to read your data.Finished building documentation for 'AsyncSequenceReader' (0.27s)
Generated documentation archive at:
/Users/admin/builder/spi-builder-workspace/.docs/mochidev/asyncsequencereader/main
Fetching https://github.com/swiftlang/swift-docc-plugin
[1/2044] Fetching swift-docc-plugin
Fetched https://github.com/swiftlang/swift-docc-plugin from cache (1.36s)
Computing version for https://github.com/swiftlang/swift-docc-plugin
Computed https://github.com/swiftlang/swift-docc-plugin at 1.4.3 (3.21s)
Fetching https://github.com/swiftlang/swift-docc-symbolkit
[1/3198] Fetching swift-docc-symbolkit
Fetched https://github.com/swiftlang/swift-docc-symbolkit from cache (1.23s)
Computing version for https://github.com/swiftlang/swift-docc-symbolkit
Computed https://github.com/swiftlang/swift-docc-symbolkit at 1.0.0 (0.60s)
Creating working copy for https://github.com/swiftlang/swift-docc-symbolkit
Working copy of https://github.com/swiftlang/swift-docc-symbolkit resolved at 1.0.0
Creating working copy for https://github.com/swiftlang/swift-docc-plugin
Working copy of https://github.com/swiftlang/swift-docc-plugin resolved at 1.4.3
Building for debugging...
[0/8] Write sources
[3/8] Write snippet-extract-tool-entitlement.plist
[4/8] Write swift-version--7754E27361AE5C74.txt
[6/53] Compiling SymbolKit Names.swift
[7/53] Compiling SymbolKit SPI.swift
[8/53] Compiling SymbolKit Snippet.swift
[9/53] Compiling SymbolKit Extension.swift
[10/57] Compiling Snippets Snippet.swift
[11/57] Emitting module Snippets
[12/57] Compiling Snippets SnippetParser.swift
[13/57] Emitting module SymbolKit
[14/57] Compiling SymbolKit Relationship.swift
[15/57] Compiling SymbolKit RelationshipKind.swift
[16/57] Compiling SymbolKit SourceOrigin.swift
[17/57] Compiling SymbolKit GenericConstraints.swift
[18/57] Compiling SymbolKit Swift.swift
[19/57] Compiling SymbolKit Identifier.swift
[20/57] Compiling SymbolKit KindIdentifier.swift
[21/57] Compiling SymbolKit Location.swift
[22/57] Compiling SymbolKit Mutability.swift
[23/57] Compiling SymbolKit SourceRange.swift
[24/57] Compiling SymbolKit Metadata.swift
[25/57] Compiling SymbolKit Module.swift
[26/57] Compiling SymbolKit OperatingSystem.swift
[27/57] Compiling SymbolKit Platform.swift
[28/57] Compiling SymbolKit Mixin+Equals.swift
[29/57] Compiling SymbolKit Mixin+Hash.swift
[30/57] Compiling SymbolKit Mixin.swift
[31/57] Compiling SymbolKit LineList.swift
[32/57] Compiling SymbolKit Position.swift
[33/57] Compiling SymbolKit DeclarationFragments.swift
[34/57] Compiling SymbolKit Fragment.swift
[35/57] Compiling SymbolKit FragmentKind.swift
[36/57] Compiling SymbolKit FunctionParameter.swift
[37/57] Compiling SymbolKit FunctionSignature.swift
[38/57] Compiling SymbolKit GenericConstraint.swift
[39/57] Compiling SymbolKit GenericParameter.swift
[40/57] Compiling SymbolKit Generics.swift
[41/57] Compiling SymbolKit Namespace.swift
[42/57] Compiling SymbolKit Symbol.swift
[43/57] Compiling SymbolKit SymbolKind.swift
[44/57] Compiling SymbolKit SymbolGraph.swift
[45/57] Compiling SymbolKit GraphCollector.swift
[46/57] Compiling SymbolKit SemanticVersion.swift
[47/57] Compiling SymbolKit AccessControl.swift
[48/57] Compiling SymbolKit Availability.swift
[49/57] Compiling SymbolKit AvailabilityItem.swift
[50/57] Compiling SymbolKit Domain.swift
[51/57] Compiling SymbolKit UnifiedSymbol+Encodable.swift
[52/57] Compiling SymbolKit UnifiedSymbol.swift
[53/57] Compiling SymbolKit UnifiedSymbolGraph+Encodable.swift
[54/57] Compiling SymbolKit UnifiedSymbolGraph.swift
[55/61] Compiling snippet_extract URL+Status.swift
[56/61] Compiling snippet_extract SnippetBuildCommand.swift
[57/61] Compiling snippet_extract SymbolGraph+Snippet.swift
[58/61] Emitting module snippet_extract
[58/61] Write Objects.LinkFileList
[59/61] Linking snippet-extract-tool
[60/61] Applying snippet-extract-tool
Build of product 'snippet-extract' complete! (5.55s)
Building for debugging...
[0/1] Write swift-version--7754E27361AE5C74.txt
[2/10] Compiling AsyncSequenceReader AsyncSequenceReaderError.swift
[3/10] Emitting module AsyncSequenceReader
[4/10] Compiling AsyncSequenceReader AsyncSequenceReader.swift
[5/10] Compiling AsyncSequenceReader AsyncBufferedIterator.swift
[6/10] Compiling AsyncSequenceReader AsyncReadUpToCountSequence.swift
[7/10] Compiling AsyncSequenceReader AnyReadableSequence.swift
[8/10] Compiling AsyncSequenceReader AsyncReadSequence.swift
[9/10] Compiling AsyncSequenceReader AsyncReadUpToElementsSequence.swift
[10/10] Compiling AsyncSequenceReader AsyncIteratorMapSequence.swift
Build of target: 'AsyncSequenceReader' complete! (0.39s)
718
7 /Users/admin/builder/spi-builder-workspace/.docs/mochidev/asyncsequencereader/main
✅ Doc result (uploading) reported
========================================
SyncDocs
========================================
Doc archive source directory: $PWD/.docs/mochidev/asyncsequencereader/main
File count: 718
Doc size: 7.0MB
Preparing doc bundle ...
Uploading prod-mochidev-asyncsequencereader-main-dcdfe9e7.zip to s3://spi-docs-inbox/prod-mochidev-asyncsequencereader-main-dcdfe9e7.zip
Copying... [14%]
Copying... [23%]
Copying... [32%]
Copying... [41%]
Copying... [50%]
Copying... [64%]
Copying... [73%]
Copying... [82%]
Copying... [92%]
Copying... [100%]
Done.