Rename Input(Output)ByteStream to ByteArrayIntput(Output)Stream

Author: tonyfreeman

Package.swift

@@ -25,10 +25,10 @@ addTestSuite(name: "Stream/BufferedOutputStream")
 addTestSuite(name: "Stream/BufferedStream")
 addTestSuite(name: "Stream/BufferedStreamReader")
 addTestSuite(name: "Stream/BufferedStreamWriter")
-addTestSuite(name: "Stream/InputByteStream")
+addTestSuite(name: "Stream/ByteArrayInputStream")
+addTestSuite(name: "Stream/ByteArrayOutputStream")
 addTestSuite(name: "Stream/MemoryStream")
 addTestSuite(name: "Stream/Numeric")
-addTestSuite(name: "Stream/OutputByteStream")
 addTestSuite(name: "Stream/Stream")
 addTestSuite(name: "Stream/StreamReader")
 addTestSuite(name: "Stream/SubStreamReader")

Sources/Stream/Library/ByteStream/InputByteStream+StreamReader.swift renamed to Sources/Stream/Library/ByteArrayStream/ByteArrayInputStream+StreamReader.swift

@@ -1,4 +1,4 @@
-extension InputByteStream: StreamReader {
+extension ByteArrayInputStream: StreamReader {
     public var buffered: Int {
         return bytes.count - position
     }

Sources/Stream/Library/ByteStream/InputByteStream.swift renamed to Sources/Stream/Library/ByteArrayStream/ByteArrayInputStream.swift

@@ -1,4 +1,4 @@
-public class InputByteStream: InputStream {
+public class ByteArrayInputStream: InputStream {
     public let bytes: [UInt8]
     public internal(set) var position = 0
     public var isEmpty: Bool { position == bytes.count }
@@ -23,3 +23,6 @@ public class InputByteStream: InputStream {
         return count
     }
 }
+
+@available(*, renamed: "ByteArrayInputStream")
+public typealias InputByteStream = ByteArrayInputStream

Sources/Stream/Library/ByteStream/OutputByteStream+StreamWriter.swift renamed to Sources/Stream/Library/ByteArrayStream/ByteArrayOutputStream+StreamWriter.swift

@@ -1,4 +1,4 @@
-extension OutputByteStream: StreamWriter {
+extension ByteArrayOutputStream: StreamWriter {
     public var buffered: Int {
         return bytes.count - position
     }

Sources/Stream/Library/ByteStream/OutputByteStream.swift renamed to Sources/Stream/Library/ByteArrayStream/ByteArrayOutputStream.swift

@@ -1,4 +1,4 @@
-public class OutputByteStream: OutputStream {
+public class ByteArrayOutputStream: OutputStream {
     public var bytes: [UInt8]
     public var position: Int { bytes.count }
     public var stringValue: String { .init(decoding: bytes, as: UTF8.self) }
@@ -19,3 +19,6 @@ public class OutputByteStream: OutputStream {
         return byteCount
     }
 }
+
+@available(*, renamed: "ByteArrayOutputStream")
+public typealias OutputByteStream = ByteArrayOutputStream

Sources/Stream/SubStreamReader.swift

@@ -3,7 +3,7 @@ public protocol SubStreamReader: StreamReader {
     var isEmpty: Bool { get }
 }
 
-extension InputByteStream: SubStreamReader {
+extension ByteArrayInputStream: SubStreamReader {
     public var limit: Int {
         return bytes.count
     }
@@ -27,7 +27,7 @@ extension StreamReader {
     {
         // FIXME: [Concurrency] optimize
         let bytes = try await read(count: limit)
-        let stream = InputByteStream(bytes)
+        let stream = ByteArrayInputStream(bytes)
         return try await body(stream)
     }
 }

Sources/Stream/SubStreamWriter.swift

@@ -2,7 +2,7 @@ public protocol SubStreamWriter: StreamWriter {
     var count: Int { get }
 }
 
-extension OutputByteStream: SubStreamWriter {
+extension ByteArrayOutputStream: SubStreamWriter {
     public var count: Int {
         return bytes.count
     }
@@ -14,7 +14,7 @@ extension StreamWriter {
         includingHeader: Bool = false,
         task: (SubStreamWriter) async throws -> Void) async throws
     {
-        let output = OutputByteStream()
+        let output = ByteArrayOutputStream()
         try await task(output)
         let sizeHeader = includingHeader
             ? Size(output.bytes.count + MemoryLayout<Size>.size)

Tests/Stream/BufferedInputStream/main.swift

@@ -57,7 +57,7 @@ test.case("BufferedInputStream") {
 }
 
 test.case("BufferedInputStreamDefaultCapacity") {
-    let stream = BufferedInputStream(baseStream: InputByteStream([]))
+    let stream = BufferedInputStream(baseStream: ByteArrayInputStream([]))
     expect(stream.allocated == 256)
     expect(stream.buffered == 0)
 }

Tests/Stream/BufferedOutputStream/main.swift

@@ -2,7 +2,7 @@ import Test
 @testable import Stream
 
 test.case("BufferedOutputStream") {
-    let byteStream = OutputByteStream()
+    let byteStream = ByteArrayOutputStream()
     let stream = BufferedOutputStream(baseStream: byteStream, capacity: 10)
     expect(stream.allocated == 10)
     expect(stream.buffered == 0)
@@ -43,7 +43,7 @@ test.case("BufferedOutputStream") {
 }
 
 test.case("BufferedOutputStreamDefaultCapacity") {
-    let stream = BufferedOutputStream(baseStream: OutputByteStream())
+    let stream = BufferedOutputStream(baseStream: ByteArrayOutputStream())
     expect(stream.allocated == 256)
     expect(stream.buffered == 0)
 }

Tests/Stream/BufferedStreamReader/main.swift

@@ -349,7 +349,7 @@ test.case("ConsumeUntil") {
 }
 
 test.case("ConsumeEmpty") {
-    let stream = BufferedInputStream(baseStream: InputByteStream([]))
+    let stream = BufferedInputStream(baseStream: ByteArrayInputStream([]))
     expect(throws: StreamError.insufficientData) {
         try await stream.consume(count: 1)
     }
@@ -368,15 +368,15 @@ test.case("FeedLessThanReadCount") {
 
 test.case("AdvancePositionBeforeCallback") {
     let stream = BufferedInputStream(
-        baseStream: InputByteStream([0,1,2,3,4,5,6,7,8,9]))
+        baseStream: ByteArrayInputStream([0,1,2,3,4,5,6,7,8,9]))
     try await stream.readUntilEnd { bytes in
         expect(stream.readPosition == stream.writePosition)
     }
 }
 
 test.case("ReadLine") {
     let stream = BufferedInputStream(
-        baseStream: InputByteStream([UInt8]("line1\r\nline2\n".utf8)))
+        baseStream: ByteArrayInputStream([UInt8]("line1\r\nline2\n".utf8)))
     expect(try await stream.readLine() == "line1")
     expect(try await stream.readLine() == "line2")
 }

Tests/Stream/BufferedStreamWriter/main.swift

@@ -2,7 +2,7 @@ import Test
 @testable import Stream
 
 test.case("WriteByte") {
-    let stream = OutputByteStream()
+    let stream = ByteArrayOutputStream()
     let output = BufferedOutputStream(baseStream: stream, capacity: 5)
 
     try await output.write(UInt8(42))

Tests/Stream/InputByteStream/main.swift renamed to Tests/Stream/ByteArrayInputStream/main.swift

@@ -1,14 +1,14 @@
 import Test
 @testable import Stream
 
-test.case("InputByteStream") {
-    let inputStream  = InputByteStream([])
+test.case("ByteArrayInputStream") {
+    let inputStream  = ByteArrayInputStream([])
     var buffer = [UInt8]()
     expect(try inputStream.read(to: &buffer, byteCount: 0) == 0)
 }
 
-test.case("InputByteStream advance position before callback") {
-    let input = InputByteStream([0,1,2,3,4,5,6,7,8,9])
+test.case("ByteArrayInputStream advance position before callback") {
+    let input = ByteArrayInputStream([0,1,2,3,4,5,6,7,8,9])
     try await input.readUntilEnd { bytes in
         expect(input.position == input.bytes.count)
     }

Tests/Stream/OutputByteStream/main.swift renamed to Tests/Stream/ByteArrayOutputStream/main.swift

@@ -1,14 +1,14 @@
 import Test
 @testable import Stream
 
-test.case("OutputByteStream") {
-    let outputStream  = OutputByteStream()
+test.case("ByteArrayOutputStream") {
+    let outputStream  = ByteArrayOutputStream()
     let bytes = [UInt8]()
     expect(try outputStream.write(from: bytes, byteCount: 0) == 0)
 }
 
-test.case("OutputByteStream Numeric") {
-    let outputStream  = OutputByteStream()
+test.case("ByteArrayOutputStream Numeric") {
+    let outputStream  = ByteArrayOutputStream()
 
     try outputStream.write(Int(-1))
     try outputStream.write(Int8(-2))
@@ -21,7 +21,7 @@ test.case("OutputByteStream Numeric") {
     try outputStream.write(UInt32(4))
     try outputStream.write(UInt64(5))
 
-    let inputStream  = InputByteStream(outputStream.bytes)
+    let inputStream  = ByteArrayInputStream(outputStream.bytes)
 
     expect(try inputStream.read(Int.self) == -1)
     expect(try inputStream.read(Int8.self) == -2)

Tests/Stream/Numeric/main.swift

@@ -2,18 +2,18 @@ import Test
 import Stream
 
 test.case("Int") {
-    expect(try await InputByteStream("42").parse(Int.self) == 42)
-    expect(try await InputByteStream("3.14").parse(Int.self) == 3)
-    expect(try await InputByteStream("-42").parse(Int.self) == -42)
+    expect(try await ByteArrayInputStream("42").parse(Int.self) == 42)
+    expect(try await ByteArrayInputStream("3.14").parse(Int.self) == 3)
+    expect(try await ByteArrayInputStream("-42").parse(Int.self) == -42)
 }
 
 test.case("Double") {
-    expect(try await InputByteStream("0.1").parse(Double.self) == 0.1)
-    expect(try await InputByteStream("1.0").parse(Double.self) == 1.0)
-    expect(try await InputByteStream("0.7").parse(Double.self) == 0.7)
-    expect(try await InputByteStream("3.14").parse(Double.self) == 3.14)
-    expect(try await InputByteStream("42").parse(Double.self) == 42)
-    expect(try await InputByteStream("42.").parse(Double.self) == 42)
+    expect(try await ByteArrayInputStream("0.1").parse(Double.self) == 0.1)
+    expect(try await ByteArrayInputStream("1.0").parse(Double.self) == 1.0)
+    expect(try await ByteArrayInputStream("0.7").parse(Double.self) == 0.7)
+    expect(try await ByteArrayInputStream("3.14").parse(Double.self) == 3.14)
+    expect(try await ByteArrayInputStream("42").parse(Double.self) == 42)
+    expect(try await ByteArrayInputStream("42.").parse(Double.self) == 42)
 }
 
 test.run()

Tests/Stream/StreamReader/main.swift

@@ -3,23 +3,23 @@ import Test
 
 test.case("UntilEnd") {
     let helloBytes = [UInt8]("Hello, World!".utf8)
-    let stream = InputByteStream(helloBytes)
+    let stream = ByteArrayInputStream(helloBytes)
     let bytes = try await stream.readUntilEnd()
     expect(bytes == helloBytes)
 }
 
 test.case("UntilEndAsString") {
     let helloString = "Hello, World!"
     let helloBytes = [UInt8](helloString.utf8)
-    let stream = InputByteStream(helloBytes)
+    let stream = ByteArrayInputStream(helloBytes)
     let string = try await stream.readUntilEnd(as: String.self)
     expect(string == helloString)
 }
 
 test.case("ReadLine") {
     let lines = "Hello, World!\r\nHello, World!\r\n"
-    let stream = InputByteStream([UInt8](lines.utf8))
-    
+    let stream = ByteArrayInputStream([UInt8](lines.utf8))
+
     expect(try await stream.readLine() == "Hello, World!")
     expect(try await stream.readLine() == "Hello, World!")
     expect(try await stream.readLine() == nil)

Tests/Stream/SubStreamReader/main.swift

@@ -2,8 +2,8 @@ import Test
 @testable import Stream
 
 test.case("LimitedBy") {
-    let stream = InputByteStream([UInt8]("Hello, World!".utf8))
-    let hello = try await  stream.withSubStreamReader(limitedBy: 5) { stream in
+    let stream = ByteArrayInputStream([UInt8]("Hello, World!".utf8))
+    let hello = try await stream.withSubStreamReader(limitedBy: 5) { stream in
         return try await stream.readUntilEnd(as: String.self)
     }
     try stream.consume(count: 2)
@@ -14,7 +14,7 @@ test.case("LimitedBy") {
 
 test.case("SizedBy") {
     let bytes = [0x00, 0x05] + [UInt8]("Hello, World!".utf8)
-    let stream = InputByteStream(bytes)
+    let stream = ByteArrayInputStream(bytes)
     let hello = try await stream.withSubStreamReader(sizedBy: UInt16.self)
     { stream in
         return try await stream.readUntilEnd(as: String.self)
@@ -27,7 +27,7 @@ test.case("SizedBy") {
 
 test.case("SizedByIncludingHeader") {
     let bytes = [0x00, 0x07] + [UInt8]("Hello, World!".utf8)
-    let stream = InputByteStream(bytes)
+    let stream = ByteArrayInputStream(bytes)
     let hello = try await  stream.withSubStreamReader(
         sizedBy: UInt16.self,
         includingHeader: true)

Tests/Stream/SubStreamWriter/main.swift

@@ -3,7 +3,7 @@ import Test
 
 // FIXME: [Concurrency] crash on m1
 test.case("SizedBy") {
-    let stream = OutputByteStream()
+    let stream = ByteArrayOutputStream()
     try await stream.withSubStreamWriter(sizedBy: UInt16.self) { stream in
         return try await stream.write("Hello, World!")
     }
@@ -12,7 +12,7 @@ test.case("SizedBy") {
 }
 
 test.case("SizedByIncludingHeader") {
-    let stream = OutputByteStream()
+    let stream = ByteArrayOutputStream()
     try await stream.withSubStreamWriter(
         sizedBy: UInt16.self,
         includingHeader: true)

run_tests

@@ -11,10 +11,10 @@ export DYLD_LIBRARY_PATH=/Library/Developer/Toolchains/swift-latest.xctoolchain/
 .build/debug/Tests/Stream/BufferedStream
 .build/debug/Tests/Stream/BufferedStreamReader
 .build/debug/Tests/Stream/BufferedStreamWriter
-.build/debug/Tests/Stream/InputByteStream
+.build/debug/Tests/Stream/ByteArrayInputStream
+.build/debug/Tests/Stream/ByteArrayOutputStream
 .build/debug/Tests/Stream/MemoryStream
 .build/debug/Tests/Stream/Numeric
-.build/debug/Tests/Stream/OutputByteStream
 .build/debug/Tests/Stream/Stream
 .build/debug/Tests/Stream/StreamReader
 .build/debug/Tests/Stream/SubStreamReader