Merge pull request #248 from FloEdelmann/patch-1

Add generic `decodeFromStream`/`encodeToStream` extension functions

Author: charleskorn

src/jvmMain/kotlin/com/charleskorn/kaml/Yaml.kt

@@ -24,6 +24,7 @@ import kotlinx.serialization.SerializationStrategy
 import kotlinx.serialization.StringFormat
 import kotlinx.serialization.modules.EmptySerializersModule
 import kotlinx.serialization.modules.SerializersModule
+import kotlinx.serialization.serializer
 import org.snakeyaml.engine.v2.api.StreamDataWriter
 import org.snakeyaml.engine.v2.api.YamlOutputStreamWriter
 import java.io.IOException
@@ -89,3 +90,20 @@ public actual class Yaml(
         public actual val default: Yaml = Yaml()
     }
 }
+
+/**
+ * Decodes and deserializes from the given [stream] to the value of type [T] using the
+ * deserializer retrieved from the reified type parameter.
+ */
+@OptIn(ExperimentalSerializationApi::class)
+public inline fun <reified T> Yaml.decodeFromStream(stream: InputStream): T =
+    decodeFromStream(serializersModule.serializer(), stream)
+
+/**
+ * Serializes and encodes the given [value] to the given [stream] using the serializer
+ * retrieved from the reified type parameter.
+ */
+@OptIn(ExperimentalSerializationApi::class)
+public inline fun <reified T> Yaml.encodeToStream(value: T, stream: OutputStream) {
+    encodeToStream(serializersModule.serializer(), value, stream)
+}

src/jvmTest/kotlin/com/charleskorn/kaml/JvmYamlReadingTest.kt

@@ -35,5 +35,14 @@ object JvmYamlReadingTest : Spek({
                 expect(result).toEqual(123)
             }
         }
+
+        describe("parsing from a stream via generic extension function") {
+            val input = "123"
+            val result = Yaml.default.decodeFromStream<Int>(ByteArrayInputStream(input.toByteArray(Charsets.UTF_8)))
+
+            it("successfully deserializes values from a stream") {
+                expect(result).toEqual(123)
+            }
+        }
     }
 })

src/jvmTest/kotlin/com/charleskorn/kaml/JvmYamlWritingTest.kt

@@ -110,5 +110,14 @@ object JvmYamlWritingTest : Spek({
                 }
             }
         }
+
+        describe("writing to a stream via generic extension function") {
+            val output = ByteArrayOutputStream()
+            Yaml.default.encodeToStream<String>("hello world", output)
+
+            it("returns the value serialized in the expected YAML form") {
+                expect(output.toString(Charsets.UTF_8)).toEqual("\"hello world\"\n")
+            }
+        }
     }
 })