Swift Package IndexBuild Information
Successful build of AsyncSequenceReader, reference main (cf213b), with Swift 6.3 for macOS (SPM) on 1 May 2026 15:32:53 UTC.
Swift 6 data race errors: 0
Build Command
env DEVELOPER_DIR=/Applications/Xcode-26.4.0.app xcrun swift build --arch arm64Build Log
========================================
RunAll
========================================
Builder version: 4.70.0
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 cf213b3 Updated `AsyncIteratorMapSequence` to use typed throws
Cloned https://github.com/mochidev/AsyncSequenceReader.git
Revision (git rev-parse @):
cf213b30f1289ac972c7eb6bdfd1bd46f5a59975
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",
"traits": [
"default"
],
"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",
"traits": [
"default"
],
"dependencies": [
]
}
]
}
Fetching https://github.com/mochidev/AsyncSequenceReader.git
[1/406] Fetching asyncsequencereader
Fetched https://github.com/mochidev/AsyncSequenceReader.git from cache (0.67s)
Creating working copy for https://github.com/mochidev/AsyncSequenceReader.git
Working copy of https://github.com/mochidev/AsyncSequenceReader.git resolved at main (cf213b3)
warning: '.resolve-product-dependencies': dependency 'asyncsequencereader' is not used by any target
Found 0 product dependencies
========================================
Build
========================================
Selected platform: macosSpm
Swift version: 6.3
Building package at path: $PWD
https://github.com/mochidev/AsyncSequenceReader.git
Running build ...
env DEVELOPER_DIR=/Applications/Xcode-26.4.0.app xcrun swift build --arch arm64
Building for debugging...
[0/2] Write sources
[1/2] Write swift-version--6988338F2F200930.txt
[3/12] Compiling AsyncSequenceReader AsyncSequenceReader.swift
[4/12] Compiling AsyncSequenceReader AsyncSequenceReaderError.swift
[5/12] Compiling AsyncSequenceReader AsyncIteratorMapSequence.swift
[6/12] Compiling AsyncSequenceReader AsyncReadSequence.swift
[7/12] Compiling AsyncSequenceReader AsyncReadUpToElementsSequence.swift
[8/12] Compiling AsyncSequenceReader AsyncIteratorProtocol+Isolated.swift
[9/12] Compiling AsyncSequenceReader AsyncBufferedIterator.swift
[10/12] Compiling AsyncSequenceReader AnyReadableSequence.swift
[11/12] Emitting module AsyncSequenceReader
[12/12] Compiling AsyncSequenceReader AsyncReadUpToCountSequence.swift
Build complete! (1.24s)
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" : [
"AnyReadableSequenceTests.swift",
"AsyncBufferedIteratorTests.swift",
"AsyncIteratorMapSequenceTests.swift",
"AsyncIteratorProtocol+NonIsolated.swift",
"AsyncReadUpToCountSequenceTests.swift",
"AsyncReadUpToElementsSequenceTests.swift",
"AsyncSequenceReaderErrorTests.swift",
"AsyncSequenceReaderTests.swift",
"ExitTest.Result+Lines.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",
"AsyncIteratorProtocol+Isolated.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.3
Target: AsyncSequenceReader
Extracting symbol information for 'AsyncSequenceReader'...
Finished extracting symbol information for 'AsyncSequenceReader'. (20.42s)
Building documentation for 'AsyncSequenceReader'...
warning: 'AsyncIteratorProtocol' doesn't exist at '/AsyncSequenceReader/AsyncReadSequence'
--> ../AsyncReadSequence.swift:12:195-12:216
10 | /// An AsyncSequence subtype suitable for reading an existing iterator in place.
11 | ///
12 + /// 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:)``.
13 | public protocol AsyncReadSequence: AsyncSequence, AnyObject {
14 | associatedtype BaseIterator: AsyncIteratorProtocol where BaseIterator.Element == Element
warning: External name 'throwsIfOver' used to document parameter
--> ../AsyncReadUpToElementsSequence.swift:32:21-32:33
30 | ///
31 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
32 + /// - 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'
33 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
34 | /// - 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:32:21-32:33
30 | ///
31 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
32 + /// - 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'
33 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
34 | /// - 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:32:21-32:33
30 | ///
31 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
32 + /// - 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'
33 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
34 | /// - 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:32:21-32:33
30 | ///
31 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
32 + /// - 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'
33 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
34 | /// - 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:32:21-32:33
30 | ///
31 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
32 + /// - 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'
33 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
34 | /// - 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:32:21-32:33
30 | ///
31 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
32 + /// - 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'
33 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
34 | /// - 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:32:21-32:33
30 | ///
31 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
32 + /// - 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'
33 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
34 | /// - 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:63:21-63:33
61 | ///
62 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
63 + /// - 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'
64 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
65 | /// - 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:63:21-63:33
61 | ///
62 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
63 + /// - 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'
64 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
65 | /// - 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:63:21-63:33
61 | ///
62 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
63 + /// - 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'
64 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
65 | /// - 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:63:21-63:33
61 | ///
62 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
63 + /// - 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'
64 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
65 | /// - 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:63:21-63:33
61 | ///
62 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
63 + /// - 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'
64 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
65 | /// - 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:63:21-63:33
61 | ///
62 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
63 + /// - 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'
64 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
65 | /// - 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:63:21-63:33
61 | ///
62 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
63 + /// - 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'
64 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
65 | /// - 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:111:21-111:33
109 | ///
110 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
111 + /// - 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'
112 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
113 | /// - 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:111:21-111:33
109 | ///
110 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
111 + /// - 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'
112 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
113 | /// - 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:111:21-111:33
109 | ///
110 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
111 + /// - 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'
112 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
113 | /// - 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:111:21-111:33
109 | ///
110 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
111 + /// - 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'
112 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
113 | /// - 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:111:21-111:33
109 | ///
110 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
111 + /// - 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'
112 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
113 | /// - 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:111:21-111:33
109 | ///
110 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
111 + /// - 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'
112 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
113 | /// - 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:111:21-111:33
109 | ///
110 | /// - Parameter termination: The element marking the end of the sequence that will be collected.
111 + /// - 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'
112 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
113 | /// - 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:142:21-142:33
140 | ///
141 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
142 + /// - 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'
143 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
144 | /// - 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:142:21-142:33
140 | ///
141 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
142 + /// - 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'
143 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
144 | /// - 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:142:21-142:33
140 | ///
141 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
142 + /// - 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'
143 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
144 | /// - 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:142:21-142:33
140 | ///
141 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
142 + /// - 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'
143 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
144 | /// - 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:142:21-142:33
140 | ///
141 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
142 + /// - 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'
143 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
144 | /// - 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:142:21-142:33
140 | ///
141 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
142 + /// - 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'
143 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
144 | /// - 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:142:21-142:33
140 | ///
141 | /// - Parameter termination: The sequence of elements marking the end of the sequence that will be collected.
142 + /// - 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'
143 | /// - Returns: An array of the collected elements, or `nil` if the sequence was already finished.
144 | /// - 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.56s)
Generated documentation archive at:
/Users/admin/builder/spi-builder-workspace/.docs/mochidev/asyncsequencereader/main
Fetching https://github.com/swiftlang/swift-docc-plugin
[1/2287] Fetching swift-docc-plugin
Fetched https://github.com/swiftlang/swift-docc-plugin from cache (1.25s)
Computing version for https://github.com/swiftlang/swift-docc-plugin
Computed https://github.com/swiftlang/swift-docc-plugin at 1.5.0 (4.75s)
Fetching https://github.com/swiftlang/swift-docc-symbolkit
[1/3709] Fetching swift-docc-symbolkit
Fetched https://github.com/swiftlang/swift-docc-symbolkit from cache (1.11s)
Computing version for https://github.com/swiftlang/swift-docc-symbolkit
Computed https://github.com/swiftlang/swift-docc-symbolkit at 1.0.0 (1.86s)
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.5.0
Building for debugging...
[0/8] Write sources
[1/8] Write snippet-extract-tool-entitlement.plist
[3/8] Write sources
[4/8] Write swift-version--6988338F2F200930.txt
[6/54] Emitting module SymbolKit
[7/58] Compiling SymbolKit GenericConstraint.swift
[8/58] Compiling SymbolKit GenericParameter.swift
[9/58] Compiling SymbolKit Generics.swift
[10/58] Compiling SymbolKit Namespace.swift
[11/58] Compiling SymbolKit SemanticVersion.swift
[12/58] Compiling SymbolKit AccessControl.swift
[13/58] Compiling SymbolKit Availability.swift
[14/58] Compiling SymbolKit AvailabilityItem.swift
[15/58] Compiling SymbolKit Domain.swift
[16/58] Compiling SymbolKit Names.swift
[17/58] Compiling SymbolKit SPI.swift
[18/58] Compiling SymbolKit Snippet.swift
[19/58] Compiling SymbolKit Extension.swift
[20/58] Compiling SymbolKit SourceRange.swift
[21/58] Compiling SymbolKit Metadata.swift
[22/58] Compiling SymbolKit Module.swift
[23/58] Compiling SymbolKit OperatingSystem.swift
[24/58] Compiling SymbolKit Platform.swift
[25/58] Compiling SymbolKit UnifiedSymbol+Encodable.swift
[26/58] Compiling SymbolKit UnifiedSymbol.swift
[27/58] Compiling SymbolKit UnifiedSymbolGraph+Encodable.swift
[28/58] Compiling SymbolKit UnifiedSymbolGraph.swift
[29/58] Compiling SymbolKit Mixin+Equals.swift
[30/58] Compiling SymbolKit Mixin+Hash.swift
[31/58] Compiling SymbolKit Mixin.swift
[32/58] Compiling SymbolKit LineList.swift
[33/58] Compiling SymbolKit Position.swift
[34/58] Compiling SymbolKit Relationship.swift
[35/58] Compiling SymbolKit RelationshipKind.swift
[36/58] Compiling SymbolKit SourceOrigin.swift
[37/58] Compiling SymbolKit GenericConstraints.swift
[38/58] Compiling SymbolKit Swift.swift
[39/58] Compiling SymbolKit Symbol.swift
[40/58] Compiling SymbolKit SymbolKind.swift
[41/58] Compiling SymbolKit SymbolGraph.swift
[42/58] Compiling SymbolKit GraphCollector.swift
[43/58] Compiling SymbolKit Identifier.swift
[44/58] Compiling SymbolKit KindIdentifier.swift
[45/58] Compiling SymbolKit Location.swift
[46/58] Compiling SymbolKit Mutability.swift
[47/58] Compiling SymbolKit DeclarationFragments.swift
[48/58] Compiling SymbolKit Fragment.swift
[49/58] Compiling SymbolKit FragmentKind.swift
[50/58] Compiling SymbolKit FunctionParameter.swift
[51/58] Compiling SymbolKit FunctionSignature.swift
[52/58] Compiling Snippets SnippetLanguage.swift
[53/58] Compiling Snippets Snippet.swift
[54/58] Emitting module Snippets
[55/58] Compiling Snippets SnippetParser.swift
[56/62] Compiling snippet_extract URL+Status.swift
[57/62] Compiling snippet_extract SymbolGraph+Snippet.swift
[58/62] Emitting module snippet_extract
[59/62] Compiling snippet_extract SnippetBuildCommand.swift
[59/62] Write Objects.LinkFileList
[60/62] Linking snippet-extract-tool
[61/62] Applying snippet-extract-tool
Build of product 'snippet-extract' complete! (5.73s)
Building for debugging...
[0/1] Write swift-version--6988338F2F200930.txt
Build of target: 'AsyncSequenceReader' complete! (0.24s)
652
6 /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: 652
Doc size: 6.0MB
Preparing doc bundle ...
Uploading prod-mochidev-asyncsequencereader-main-5172c538.zip to s3://spi-docs-inbox/prod-mochidev-asyncsequencereader-main-5172c538.zip
Copying... [10%]
Copying... [21%]
Copying... [31%]
Copying... [41%]
Copying... [52%]
Copying... [62%]
Copying... [72%]
Copying... [83%]
Copying... [93%]
Copying... [100%]
Done.