ByteString implementation

benchmarks/src/commonMain/kotlin/BufferOps.kt

@@ -214,8 +214,8 @@ open class Utf8StringBenchmark : BufferRWBenchmarkBase() {
     @Benchmark
     fun benchmark(): String {
         val s = buffer.size
-        buffer.writeUtf8(string)
-        return buffer.readUtf8(buffer.size - s)
+        buffer.writeString(string)
+        return buffer.readString(buffer.size - s)
     }
 }
 
@@ -257,16 +257,16 @@ open class Utf8LineBenchmarkBase : BufferRWBenchmarkBase() {
 open class Utf8LineBenchmark : Utf8LineBenchmarkBase() {
     @Benchmark
     fun benchmark(): String? {
-        buffer.writeUtf8(string)
-        return buffer.readUtf8Line()
+        buffer.writeString(string)
+        return buffer.readLine()
     }
 }
 
 open class Utf8LineStrictBenchmark : Utf8LineBenchmarkBase() {
     @Benchmark
     fun benchmark(): String {
-        buffer.writeUtf8(string)
-        return buffer.readUtf8LineStrict()
+        buffer.writeString(string)
+        return buffer.readLineStrict()
     }
 }
 

bytestring/Module.md

@@ -0,0 +1,3 @@
+# Module kotlinx-io-bytestring
+
+The module provides the [ByteString] - an immutable sequence of bytes, and extensions facilitating work with it.

bytestring/api/kotlinx-io-bytestring.api

@@ -0,0 +1,84 @@
+public final class kotlinx/io/bytestring/ByteString : java/lang/Comparable {
+	public static final field Companion Lkotlinx/io/bytestring/ByteString$Companion;
+	public fun <init> ([BII)V
+	public synthetic fun <init> ([BIIILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public synthetic fun <init> ([BLjava/lang/Object;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public synthetic fun compareTo (Ljava/lang/Object;)I
+	public fun compareTo (Lkotlinx/io/bytestring/ByteString;)I
+	public final fun copyInto ([BIII)V
+	public static synthetic fun copyInto$default (Lkotlinx/io/bytestring/ByteString;[BIIIILjava/lang/Object;)V
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun get (I)B
+	public final fun getBackingArrayReference ()[B
+	public final fun getSize ()I
+	public fun hashCode ()I
+	public final fun substring (II)Lkotlinx/io/bytestring/ByteString;
+	public static synthetic fun substring$default (Lkotlinx/io/bytestring/ByteString;IIILjava/lang/Object;)Lkotlinx/io/bytestring/ByteString;
+	public final fun toByteArray (II)[B
+	public static synthetic fun toByteArray$default (Lkotlinx/io/bytestring/ByteString;IIILjava/lang/Object;)[B
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class kotlinx/io/bytestring/ByteString$Companion {
+}
+
+public final class kotlinx/io/bytestring/ByteStringBuilder {
+	public fun <init> ()V
+	public fun <init> (I)V
+	public synthetic fun <init> (IILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public final fun append (B)V
+	public final fun append ([BII)V
+	public static synthetic fun append$default (Lkotlinx/io/bytestring/ByteStringBuilder;[BIIILjava/lang/Object;)V
+	public final fun getCapacity ()I
+	public final fun getSize ()I
+	public final fun toByteString ()Lkotlinx/io/bytestring/ByteString;
+}
+
+public final class kotlinx/io/bytestring/ByteStringBuilderKt {
+	public static final fun append (Lkotlinx/io/bytestring/ByteStringBuilder;Lkotlinx/io/bytestring/ByteString;)V
+	public static final fun append (Lkotlinx/io/bytestring/ByteStringBuilder;[B)V
+	public static final fun append-EK-6454 (Lkotlinx/io/bytestring/ByteStringBuilder;B)V
+	public static final fun buildByteString (ILkotlin/jvm/functions/Function1;)Lkotlinx/io/bytestring/ByteString;
+	public static synthetic fun buildByteString$default (ILkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lkotlinx/io/bytestring/ByteString;
+}
+
+public final class kotlinx/io/bytestring/ByteStringJvmExtKt {
+	public static final fun decodeToString (Lkotlinx/io/bytestring/ByteString;Ljava/nio/charset/Charset;)Ljava/lang/String;
+	public static final fun encodeToByteString (Ljava/lang/String;Ljava/nio/charset/Charset;)Lkotlinx/io/bytestring/ByteString;
+}
+
+public final class kotlinx/io/bytestring/ByteStringKt {
+	public static final fun ByteString ([B)Lkotlinx/io/bytestring/ByteString;
+	public static final fun contentEquals (Lkotlinx/io/bytestring/ByteString;[B)Z
+	public static final fun decodeToString (Lkotlinx/io/bytestring/ByteString;)Ljava/lang/String;
+	public static final fun encodeToByteString (Ljava/lang/String;)Lkotlinx/io/bytestring/ByteString;
+	public static final fun endsWith (Lkotlinx/io/bytestring/ByteString;Lkotlinx/io/bytestring/ByteString;)Z
+	public static final fun endsWith (Lkotlinx/io/bytestring/ByteString;[B)Z
+	public static final fun getIndices (Lkotlinx/io/bytestring/ByteString;)Lkotlin/ranges/IntRange;
+	public static final fun indexOf (Lkotlinx/io/bytestring/ByteString;BI)I
+	public static final fun indexOf (Lkotlinx/io/bytestring/ByteString;Lkotlinx/io/bytestring/ByteString;I)I
+	public static final fun indexOf (Lkotlinx/io/bytestring/ByteString;[BI)I
+	public static synthetic fun indexOf$default (Lkotlinx/io/bytestring/ByteString;BIILjava/lang/Object;)I
+	public static synthetic fun indexOf$default (Lkotlinx/io/bytestring/ByteString;Lkotlinx/io/bytestring/ByteString;IILjava/lang/Object;)I
+	public static synthetic fun indexOf$default (Lkotlinx/io/bytestring/ByteString;[BIILjava/lang/Object;)I
+	public static final fun isEmpty (Lkotlinx/io/bytestring/ByteString;)Z
+	public static final fun isNotEmpty (Lkotlinx/io/bytestring/ByteString;)Z
+	public static final fun lastIndexOf (Lkotlinx/io/bytestring/ByteString;BI)I
+	public static final fun lastIndexOf (Lkotlinx/io/bytestring/ByteString;Lkotlinx/io/bytestring/ByteString;I)I
+	public static final fun lastIndexOf (Lkotlinx/io/bytestring/ByteString;[BI)I
+	public static synthetic fun lastIndexOf$default (Lkotlinx/io/bytestring/ByteString;BIILjava/lang/Object;)I
+	public static synthetic fun lastIndexOf$default (Lkotlinx/io/bytestring/ByteString;Lkotlinx/io/bytestring/ByteString;IILjava/lang/Object;)I
+	public static synthetic fun lastIndexOf$default (Lkotlinx/io/bytestring/ByteString;[BIILjava/lang/Object;)I
+	public static final fun startsWith (Lkotlinx/io/bytestring/ByteString;Lkotlinx/io/bytestring/ByteString;)Z
+	public static final fun startsWith (Lkotlinx/io/bytestring/ByteString;[B)Z
+}
+
+public abstract interface annotation class kotlinx/io/bytestring/unsafe/UnsafeByteStringApi : java/lang/annotation/Annotation {
+}
+
+public final class kotlinx/io/bytestring/unsafe/UnsafeByteStringOperations {
+	public static final field INSTANCE Lkotlinx/io/bytestring/unsafe/UnsafeByteStringOperations;
+	public final fun withByteArrayUnsafe (Lkotlinx/io/bytestring/ByteString;Lkotlin/jvm/functions/Function1;)V
+	public final fun wrapUnsafe ([B)Lkotlinx/io/bytestring/ByteString;
+}
+

bytestring/build.gradle.kts

@@ -0,0 +1,80 @@
+import org.jetbrains.dokka.gradle.DokkaTaskPartial
+import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet
+
+plugins {
+    kotlin("multiplatform")
+    id("org.jetbrains.kotlinx.kover") version "0.7.1"
+    id("org.jetbrains.dokka") version "1.8.20"
+}
+
+kotlin {
+    jvm {
+        withJava()
+        testRuns["test"].executionTask.configure {
+            useJUnitPlatform()
+        }
+    }
+
+    js(IR) {
+        nodejs {
+            testTask {
+                useMocha {
+                    timeout = "30s"
+                }
+            }
+        }
+        browser {
+            testTask {
+                filter.setExcludePatterns("*SmokeFileTest*")
+                useMocha {
+                    timeout = "30s"
+                }
+            }
+        }
+    }
+
+    configureNativePlatforms()
+    sourceSets {
+        val commonMain by getting
+        val commonTest by getting {
+            dependencies {
+                implementation(kotlin("test"))
+            }
+        }
+        val jvmMain by getting
+        val jvmTest by getting
+
+        createSourceSet("nativeMain", parent = commonMain, children = nativeTargets)
+        createSourceSet("nativeTest", parent = commonTest, children = nativeTargets)
+    }
+
+    explicitApi()
+    sourceSets.configureEach {
+        configureSourceSet()
+    }
+}
+
+fun KotlinSourceSet.configureSourceSet() {
+    val srcDir = if (name.endsWith("Main")) "src" else "test"
+    val platform = name.dropLast(4)
+    kotlin.srcDir("$platform/$srcDir")
+    if (name == "jvmMain") {
+        resources.srcDir("$platform/resources")
+    } else if (name == "jvmTest") {
+        resources.srcDir("$platform/test-resources")
+    }
+    languageSettings {
+        progressiveMode = true
+    }
+}
+
+tasks.withType<DokkaTaskPartial>().configureEach {
+    dokkaSourceSets.configureEach {
+        includes.from("Module.md")
+
+        perPackageOption {
+            suppress.set(true)
+            matchingRegex.set(".*unsafe.*")
+        }
+    }
+}