Introduced Binary interface and modified BytesTest to use it.

Author: altavir

build.gradle

@@ -1,5 +1,6 @@
 buildscript {
     repositories {
+        mavenLocal()
         jcenter()
         gradlePluginPortal()
         maven { url "https://dl.bintray.com/kotlin/kotlin-eap" }
@@ -16,7 +17,7 @@ buildscript {
         classpath "org.jetbrains.kotlin:kotlin-allopen:$kotlin_version"
         classpath "org.jetbrains.kotlinx:kotlinx.benchmark.gradle:$benchmarks_version"
         classpath "com.vanniktech:gradle-android-junit-jacoco-plugin:0.15.0"
-        classpath "scientifik:gradle-tools:0.2.4"
+        classpath "scientifik:gradle-tools:0.2.5"
     }
 }
 

core/commonMain/src/kotlinx/io/Binary.kt

@@ -0,0 +1,26 @@
+package kotlinx.io
+
+typealias BinarySize = Int
+
+/**
+ * A generic representation of reusable input.
+ */
+interface Binary {
+    /**
+     * The size of the input in bytes or [INFINITE] in case the size could not be estimated
+     */
+    val size: BinarySize
+
+    /**
+     * Open the input, read and transform it to given result type then close it.
+     * This method ensures input is closed properly in case of exception inside and prevents leaking of input.
+     */
+    fun <R> read(reader: Input.() -> R): R
+
+    companion object {
+        /**
+         * Designates that the binary does not have fixed size, but instead is read until EOF
+         */
+        val INFINITE = BinarySize.MAX_VALUE
+    }
+}

core/commonMain/src/kotlinx/io/Bytes.kt

@@ -1,7 +1,7 @@
 package kotlinx.io
 
-import kotlinx.io.buffer.*
-import kotlinx.io.pool.*
+import kotlinx.io.buffer.Buffer
+import kotlinx.io.pool.ObjectPool
 
 internal typealias BytesPointer = Int
 
@@ -19,7 +19,7 @@ internal typealias BytesPointer = Int
  * 2. close
  * 3. example
  */
-class Bytes internal constructor(internal val bufferPool: ObjectPool<Buffer>) : Closeable {
+class Bytes internal constructor(internal val bufferPool: ObjectPool<Buffer>) : Closeable, Binary {
     private var buffers: Array<Buffer?> = arrayOfNulls(initialPreviewSize)
     private var limits: IntArray = IntArray(initialPreviewSize)
     private var head: Int = 0
@@ -28,7 +28,7 @@ class Bytes internal constructor(internal val bufferPool: ObjectPool<Buffer>) :
     /**
      * Calculate size of [Bytes].
      */
-    fun size(): Int = size(StartPointer)
+    override val size: BinarySize by lazy { size(StartPointer) }
 
     /**
      * Create [Input] view on content.
@@ -38,6 +38,9 @@ class Bytes internal constructor(internal val bufferPool: ObjectPool<Buffer>) :
         override fun fill(buffer: Buffer): Int = 0
     }
 
+    @Suppress("OVERRIDE_BY_INLINE")
+    override inline fun <R> read(reader: Input.() -> R): R = input().use(reader)
+
     override fun toString() = "Bytes($head..$tail)"
 
     /**

core/commonTest/src/kotlinx/io/tests/BytesTest.kt

@@ -26,7 +26,7 @@ class BytesTest {
             writeUTF8String("OK\n")
         }
 
-        assertEquals(2 + 2 + 2 + 4 + 8 + 4 + 8 + 8 + 3, bytes.size())
+        assertEquals(2 + 2 + 2 + 4 + 8 + 4 + 8 + 8 + 3, bytes.size)
 
         val input = bytes.input()
         val ba = ByteArray(2)
@@ -63,7 +63,7 @@ class BytesTest {
             writeUTF8String("OK\n")
             val text = listOf(1, 2, 3).joinToString(separator = "|")
             writeUTF8String("$text\n")
-        }.useInput {
+        }.read {
             readArray(ByteArray(9999))
             assertEquals(0x12, readByte())
             assertEquals(0x1234, readShort())
@@ -93,7 +93,7 @@ class BytesTest {
     fun testSingleBufferSkip() {
         buildBytes {
             writeArray("ABC123\n".toByteArray0())
-        }.useInput {
+        }.read {
             readArray(ByteArray(3))
             assertEquals("123", readUTF8Line())
             assertTrue { eof() }
@@ -102,9 +102,9 @@ class BytesTest {
 
     @Test
     fun testSingleBufferSkipExact() {
-        val p = buildBytes {
+        buildBytes {
             writeArray("ABC123".toByteArray0())
-        }.useInput {
+        }.read {
             readArray(ByteArray(3))
             assertEquals("123", readUTF8String(3))
             assertTrue { eof() }
@@ -116,7 +116,7 @@ class BytesTest {
     fun testSingleBufferSkipExactTooMuch() {
         buildBytes {
             writeArray("ABC123".toByteArray0())
-        }.useInput {
+        }.read {
             assertFailsWith<EOFException> {
                 readArray(ByteArray(1000))
             }
@@ -131,7 +131,7 @@ class BytesTest {
     fun testMultiBufferSkipTooMuch() {
         buildBytes {
             writeArray(ByteArray(99999))
-        }.useInput {
+        }.read {
             assertTrue { eof() }
         }
 
@@ -142,7 +142,7 @@ class BytesTest {
         buildBytes {
             writeArray(ByteArray(99999))
             writeArray("ABC123\n".toByteArray0())
-        }.useInput {
+        }.read {
             readArray(ByteArray(99999 + 3))
             assertEquals("123", readUTF8Line())
             assertTrue { eof() }
@@ -155,7 +155,7 @@ class BytesTest {
             repeat(PACKET_BUFFER_SIZE + 3) {
                 writeByte(1)
             }
-        }.useInput {
+        }.read {
             readArray(ByteArray(PACKET_BUFFER_SIZE - 1))
             assertEquals(0x01010101, readInt())
             assertTrue { eof() }
@@ -168,7 +168,7 @@ class BytesTest {
             repeat(PACKET_BUFFER_SIZE + 1) {
                 writeByte(1)
             }
-        }.useInput {
+        }.read {
             readArray(ByteArray(PACKET_BUFFER_SIZE - 1))
 
             try {
@@ -182,15 +182,15 @@ class BytesTest {
     @Test
     fun testReadByteEmptyPacket() {
         assertFailsWith<EOFException> {
-            buildBytes { }.useInput {
+            buildBytes { }.read {
                 readInt()
             }
         }
 
         assertFailsWith<EOFException> {
             buildBytes {
                 writeInt(1)
-            }.useInput {
+            }.read {
                 readInt()
                 readByte()
             }

core/commonTest/src/kotlinx/io/tests/TestUtils.kt

@@ -15,7 +15,7 @@ open class OutputStringTest {
             writeUTF8String(text)
         }
 
-        assertEquals(expected.size, bytes.size(), "Size $size")
+        assertEquals(expected.size, bytes.size, "Size $size")
         val input = bytes.input()
         val read = UByteArray(expected.size)
         input.readArray(read)
@@ -32,7 +32,7 @@ open class OutputStringTest {
             writeUTF8String(text)
         }
 
-        assertEquals(expected.size, bytes.size(), "Size $size")
+        assertEquals(expected.size, bytes.size, "Size $size")
         val input = bytes.input()
         val read = UByteArray(expected.size)
         input.readArray(read)
@@ -58,7 +58,7 @@ open class OutputStringTest {
             writeUTF8String(text)
         }
 
-        assertEquals(expected.size, bytes.size(), "Size $size")
+        assertEquals(expected.size, bytes.size, "Size $size")
 
         val input = bytes.input()
         val read = UByteArray(expected.size)

core/commonTest/src/kotlinx/io/tests/text/OutputStringTest.kt

@@ -1,5 +1,5 @@
 group=org.jetbrains.kotlinx
-version=0.2.0-npm-dev-1
+version=0.2.0-npm-dev-2
 org.gradle.parallel=true
 
 # kotlin

gradle.properties

@@ -1,5 +1,6 @@
 pluginManagement {
     repositories {
+        mavenLocal()
         mavenCentral()
         jcenter()
         gradlePluginPortal()
@@ -8,7 +9,7 @@ pluginManagement {
     }
 }
 
-//enableFeaturePreview('GRADLE_METADATA')
+enableFeaturePreview('GRADLE_METADATA')
 
 rootProject.name = 'kotlinx-io-package'