mirror of
https://github.com/apple/swift-async-algorithms
synced 2026-11-22 04:10:40 +00:00
* Change all AsyncStreaming availability from 26.2 to SwiftStdlib 5.0 * Spelling
40 lines
1.6 KiB
Swift
40 lines
1.6 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift Async Algorithms open source project
|
|
//
|
|
// Copyright (c) 2026 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#if UnstableAsyncStreaming && compiler(>=6.4)
|
|
public import ContainersPreview
|
|
|
|
/// Reads elements asynchronously into a caller-provided buffer.
|
|
///
|
|
/// Adopt ``CallerAsyncReader`` when you need caller-managed buffering,
|
|
/// where the caller supplies a buffer that the reader fills
|
|
/// with elements.
|
|
@available(macOS 10.14.4, iOS 12.2, watchOS 5.2, tvOS 12.2, *)
|
|
public protocol CallerAsyncReader<ReadElement, ReadFailure>: ~Copyable, ~Escapable {
|
|
/// The type of elements this reader reads.
|
|
associatedtype ReadElement: ~Copyable
|
|
|
|
/// The error type that reading operations throw.
|
|
associatedtype ReadFailure: Error
|
|
|
|
/// Reads elements from the source into the provided buffer.
|
|
///
|
|
/// This method appends elements into `buffer`. When the read operation
|
|
/// reaches the end of the source, it appends no elements.
|
|
///
|
|
/// - Parameter buffer: The buffer to fill with read elements.
|
|
/// - Throws: A `ReadFailure` from the underlying read operation.
|
|
mutating func read<Buffer: RangeReplaceableContainer<ReadElement> & ~Copyable>(
|
|
into buffer: inout Buffer
|
|
) async throws(ReadFailure) where Buffer.Element: ~Copyable
|
|
}
|
|
#endif
|