Skip to content

Commit 212047f

Browse files
committed
Modify header doc to indicate that .string and .bytes outputs have unlimited buffer size
1 parent 27648e7 commit 212047f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

Sources/Subprocess/IO/Output.swift

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,9 @@ extension OutputProtocol where Self == FileDescriptorOutput {
241241
#endif
242242
extension OutputProtocol where Self == StringOutput<UTF8> {
243243
/// Create a `Subprocess` output that collects output as UTF8 String
244+
/// with an unlimited buffer size. The memory requirement for collecting
245+
/// output is directly proportional to the size of the output
246+
/// emitted by the child process.
244247
public static var string: Self {
245248
.init(limit: .max, encoding: UTF8.self)
246249
}
@@ -264,7 +267,10 @@ extension OutputProtocol {
264267
@available(SubprocessSpan, *)
265268
#endif
266269
extension OutputProtocol where Self == BytesOutput {
267-
/// Create a `Subprocess` output that collects output as `Buffer`
270+
/// Create a `Subprocess` output that collects output as a `Buffer`
271+
/// with an unlimited buffer size. The memory requirement for collecting
272+
/// output is directly proportional to the size of the output
273+
/// emitted by the child process.
268274
public static var bytes: Self { .init(limit: .max) }
269275

270276
/// Create a `Subprocess` output that collects output as

0 commit comments

Comments
 (0)