Improve API

Author: fzhinkin

core/api/kotlinx-io-core.api

@@ -284,7 +284,7 @@ public final class kotlinx/io/files/PathsKt {
 
 public final class kotlinx/io/unsafe/UnsafeBufferOperations {
 	public static final field INSTANCE Lkotlinx/io/unsafe/UnsafeBufferOperations;
-	public static final field maxSafeWriteCapacity I
+	public final fun getMaxSafeWriteCapacity ()I
 	public final fun moveToTail (Lkotlinx/io/Buffer;[BII)V
 	public static synthetic fun moveToTail$default (Lkotlinx/io/unsafe/UnsafeBufferOperations;Lkotlinx/io/Buffer;[BIIILjava/lang/Object;)V
 	public final fun readFromHead (Lkotlinx/io/Buffer;Lkotlin/jvm/functions/Function3;)V

core/api/kotlinx-io-core.klib.api

@@ -165,11 +165,11 @@ final fun kotlinx.io.files/Path(kotlinx.io.files/Path, kotlin/Array<out kotlin/S
 final fun kotlinx.io/discardingSink(): kotlinx.io/RawSink // kotlinx.io/discardingSink|discardingSink(){}[0]
 final inline fun (kotlinx.io/Sink).kotlinx.io/writeToInternalBuffer(kotlin/Function1<kotlinx.io/Buffer, kotlin/Unit>) // kotlinx.io/writeToInternalBuffer|writeToInternalBuffer@kotlinx.io.Sink(kotlin.Function1<kotlinx.io.Buffer,kotlin.Unit>){}[0]
 final object kotlinx.io.unsafe/UnsafeBufferOperations { // kotlinx.io.unsafe/UnsafeBufferOperations|null[0]
-    final const val maxSafeWriteCapacity // kotlinx.io.unsafe/UnsafeBufferOperations.maxSafeWriteCapacity|{}maxSafeWriteCapacity[0]
-        final fun <get-maxSafeWriteCapacity>(): kotlin/Int // kotlinx.io.unsafe/UnsafeBufferOperations.maxSafeWriteCapacity.<get-maxSafeWriteCapacity>|<get-maxSafeWriteCapacity>(){}[0]
     final fun moveToTail(kotlinx.io/Buffer, kotlin/ByteArray, kotlin/Int = ..., kotlin/Int = ...) // kotlinx.io.unsafe/UnsafeBufferOperations.moveToTail|moveToTail(kotlinx.io.Buffer;kotlin.ByteArray;kotlin.Int;kotlin.Int){}[0]
     final inline fun readFromHead(kotlinx.io/Buffer, kotlin/Function3<kotlin/ByteArray, kotlin/Int, kotlin/Int, kotlin/Int>) // kotlinx.io.unsafe/UnsafeBufferOperations.readFromHead|readFromHead(kotlinx.io.Buffer;kotlin.Function3<kotlin.ByteArray,kotlin.Int,kotlin.Int,kotlin.Int>){}[0]
     final inline fun writeToTail(kotlinx.io/Buffer, kotlin/Int, kotlin/Function3<kotlin/ByteArray, kotlin/Int, kotlin/Int, kotlin/Int>) // kotlinx.io.unsafe/UnsafeBufferOperations.writeToTail|writeToTail(kotlinx.io.Buffer;kotlin.Int;kotlin.Function3<kotlin.ByteArray,kotlin.Int,kotlin.Int,kotlin.Int>){}[0]
+    final val maxSafeWriteCapacity // kotlinx.io.unsafe/UnsafeBufferOperations.maxSafeWriteCapacity|{}maxSafeWriteCapacity[0]
+        final fun <get-maxSafeWriteCapacity>(): kotlin/Int // kotlinx.io.unsafe/UnsafeBufferOperations.maxSafeWriteCapacity.<get-maxSafeWriteCapacity>|<get-maxSafeWriteCapacity>(){}[0]
 }
 final val kotlinx.io.files/SystemFileSystem // kotlinx.io.files/SystemFileSystem|{}SystemFileSystem[0]
     final fun <get-SystemFileSystem>(): kotlinx.io.files/FileSystem // kotlinx.io.files/SystemFileSystem.<get-SystemFileSystem>|<get-SystemFileSystem>(){}[0]

core/common/src/unsafe/UnsafeBufferOperations.kt

@@ -12,7 +12,7 @@ public object UnsafeBufferOperations {
     /**
      * Maximum value that is safe to pass to [writeToTail].
      */
-    public const val maxSafeWriteCapacity: Int = Segment.SIZE
+    public val maxSafeWriteCapacity: Int = Segment.SIZE
 
     /**
      * Moves [bytes] to the end of the [buffer].
@@ -74,12 +74,15 @@ public object UnsafeBufferOperations {
      * and the copy will be created if it could not be omitted.
      *
      * @throws IllegalStateException when [readAction] returns negative value or a values exceeding
-     * the `endIndex - startIndex` value.
+     * the `endIndexExclusive - startIndexInclusive` value.
      * @throws IllegalArgumentException when the [buffer] is empty.
      *
      * @sample kotlinx.io.samples.unsafe.UnsafeBufferOperationsSamples.readByteArrayFromHead
      */
-    public inline fun readFromHead(buffer: Buffer, readAction: (ByteArray, Int, Int) -> Int) {
+    public inline fun readFromHead(
+        buffer: Buffer,
+        readAction: (bytes: ByteArray, startIndexInclusive: Int, endIndexExclusive: Int) -> Int
+    ) {
         require(!buffer.exhausted()) { "Buffer is empty" }
         val head = buffer.head!!
         val bytesRead = readAction(head.dataAsByteArray(true), head.pos, head.limit)
@@ -115,11 +118,14 @@ public object UnsafeBufferOperations {
      *
      * @throws IllegalStateException when [minimumCapacity] is too large and could not be fulfilled.
      * @throws IllegalStateException when [writeAction] returns a negative value or a value exceeding
-     * the `endIndex - startIndex` value.
+     * the `endIndexExclusive - startIndexInclusive` value.
      *
      * @sample kotlinx.io.samples.unsafe.UnsafeBufferOperationsSamples.writeByteArrayToTail
      */
-    public inline fun writeToTail(buffer: Buffer, minimumCapacity: Int, writeAction: (ByteArray, Int, Int) -> Int) {
+    public inline fun writeToTail(
+        buffer: Buffer, minimumCapacity: Int,
+        writeAction: (bytes: ByteArray, startIndexInclusive: Int, endIndexExclusive: Int) -> Int
+    ) {
         val tail = buffer.writableSegment(minimumCapacity)
 
         val data = tail.dataAsByteArray(false)

core/jvm/src/unsafe/UnsafeBufferOperationsJvm.kt

@@ -128,7 +128,7 @@ public inline fun UnsafeBufferOperations.writeToTail(
 public inline fun UnsafeBufferOperations.readBulk(
     buffer: Buffer,
     iovec: Array<ByteBuffer?>,
-    readAction: (Array<ByteBuffer?>, Int) -> Long
+    readAction: (iovec: Array<ByteBuffer?>, iovecSize: Int) -> Long
 ) {
     val head = buffer.head ?: throw IllegalArgumentException("buffer is empty.")
     if (iovec.isEmpty()) throw IllegalArgumentException("iovec is empty.")