add CborEncoder.encoderCborElement

Author: JesusMcCloud

formats/cbor/api/kotlinx-serialization-cbor.api

@@ -114,11 +114,13 @@ public final class kotlinx/serialization/cbor/CborElement$Companion {
 }
 
 public abstract interface class kotlinx/serialization/cbor/CborEncoder : kotlinx/serialization/encoding/Encoder {
+	public fun encodeCborElement (Lkotlinx/serialization/cbor/CborElement;)V
 	public abstract fun getCbor ()Lkotlinx/serialization/cbor/Cbor;
 }
 
 public final class kotlinx/serialization/cbor/CborEncoder$DefaultImpls {
 	public static fun beginCollection (Lkotlinx/serialization/cbor/CborEncoder;Lkotlinx/serialization/descriptors/SerialDescriptor;I)Lkotlinx/serialization/encoding/CompositeEncoder;
+	public static fun encodeCborElement (Lkotlinx/serialization/cbor/CborEncoder;Lkotlinx/serialization/cbor/CborElement;)V
 	public static fun encodeNotNullMark (Lkotlinx/serialization/cbor/CborEncoder;)V
 	public static fun encodeNullableSerializableValue (Lkotlinx/serialization/cbor/CborEncoder;Lkotlinx/serialization/SerializationStrategy;Ljava/lang/Object;)V
 	public static fun encodeSerializableValue (Lkotlinx/serialization/cbor/CborEncoder;Lkotlinx/serialization/SerializationStrategy;Ljava/lang/Object;)V

formats/cbor/api/kotlinx-serialization-cbor.klib.api

@@ -52,6 +52,8 @@ abstract interface kotlinx.serialization.cbor/CborDecoder : kotlinx.serializatio
 abstract interface kotlinx.serialization.cbor/CborEncoder : kotlinx.serialization.encoding/Encoder { // kotlinx.serialization.cbor/CborEncoder|null[0]
     abstract val cbor // kotlinx.serialization.cbor/CborEncoder.cbor|{}cbor[0]
         abstract fun <get-cbor>(): kotlinx.serialization.cbor/Cbor // kotlinx.serialization.cbor/CborEncoder.cbor.<get-cbor>|<get-cbor>(){}[0]
+
+    open fun encodeCborElement(kotlinx.serialization.cbor/CborElement) // kotlinx.serialization.cbor/CborEncoder.encodeCborElement|encodeCborElement(kotlinx.serialization.cbor.CborElement){}[0]
 }
 
 final class kotlinx.serialization.cbor/CborBoolean : kotlinx.serialization.cbor/CborPrimitive<kotlin/Boolean> { // kotlinx.serialization.cbor/CborBoolean|null[0]

formats/cbor/commonMain/src/kotlinx/serialization/cbor/CborElement.kt

@@ -21,6 +21,7 @@ import kotlinx.serialization.cbor.internal.*
  * The whole hierarchy is [serializable][Serializable] only by [Cbor] format.
  */
 @Serializable(with = CborElementSerializer::class)
+@ExperimentalSerializationApi
 public sealed class CborElement(
     /**
      * CBOR tags associated with this element.
@@ -60,6 +61,7 @@ public sealed class CborElement(
  * CBOR primitives include numbers, strings, booleans, byte arrays and special null value [CborNull].
  */
 @Serializable(with = CborPrimitiveSerializer::class)
+@ExperimentalSerializationApi
 public sealed class CborPrimitive<T : Any>(
     public val value: T,
     tags: ULongArray = ulongArrayOf()
@@ -96,6 +98,7 @@ public sealed class CborPrimitive<T : Any>(
  * depending on the value of [sign]. Note that [absoluteValue] **must** be `0` when sign is set to [Sign.ZERO]
  */
 @Serializable(with = CborIntSerializer::class)
+@ExperimentalSerializationApi
 public class CborInt(
     absoluteValue: ULong,
     public val sign: Sign,
@@ -179,6 +182,7 @@ public class CborInt(
  * Class representing CBOR floating point value (major type 7).
  */
 @Serializable(with = CborFloatSerializer::class)
+@ExperimentalSerializationApi
 public class CborFloat(
     value: Double,
     vararg tags: ULong
@@ -188,6 +192,7 @@ public class CborFloat(
  * Class representing CBOR string value.
  */
 @Serializable(with = CborStringSerializer::class)
+@ExperimentalSerializationApi
 public class CborString(
     value: String,
     vararg tags: ULong
@@ -197,6 +202,7 @@ public class CborString(
  * Class representing CBOR boolean value.
  */
 @Serializable(with = CborBooleanSerializer::class)
+@ExperimentalSerializationApi
 public class CborBoolean(
     value: Boolean,
     vararg tags: ULong
@@ -206,6 +212,7 @@ public class CborBoolean(
  * Class representing CBOR byte string value.
  */
 @Serializable(with = CborByteStringSerializer::class)
+@ExperimentalSerializationApi
 public class CborByteString(
     value: ByteArray,
     vararg tags: ULong
@@ -235,6 +242,7 @@ public class CborByteString(
  * Class representing CBOR `null` value
  */
 @Serializable(with = CborNullSerializer::class)
+@ExperimentalSerializationApi
 public class CborNull(vararg tags: ULong) : CborPrimitive<Unit>(Unit, tags)
 
 /**
@@ -244,6 +252,7 @@ public class CborNull(vararg tags: ULong) : CborPrimitive<Unit>(Unit, tags)
  * traditional methods like [Map.get] or [Map.getValue] to obtain CBOR elements.
  */
 @Serializable(with = CborMapSerializer::class)
+@ExperimentalSerializationApi
 public class CborMap(
     private val content: Map<CborElement, CborElement>,
     vararg tags: ULong
@@ -270,6 +279,7 @@ public class CborMap(
  * traditional methods like [List.get] or [List.size] to obtain CBOR elements.
  */
 @Serializable(with = CborListSerializer::class)
+@ExperimentalSerializationApi
 public class CborList(
     private val content: List<CborElement>,
     vararg tags: ULong

formats/cbor/commonMain/src/kotlinx/serialization/cbor/CborEncoder.kt

@@ -5,6 +5,7 @@
 package kotlinx.serialization.cbor
 
 import kotlinx.serialization.*
+import kotlinx.serialization.cbor.internal.CborElementSerializer
 import kotlinx.serialization.encoding.*
 
 /**
@@ -31,4 +32,33 @@ public interface CborEncoder : Encoder {
      * Exposes the current [Cbor] instance and all its configuration flags. Useful for low-level custom serializers.
      */
     public val cbor: Cbor
+    /**
+     * Appends the given CBOR [element] to the current output.
+     * This method is allowed to invoke only as the part of the whole serialization process of the class,
+     * calling this method after invoking [beginStructure] or any `encode*` method will lead to unspecified behaviour
+     * and may produce an invalid CBOR result.
+     * For example:
+     * ```
+     * class Holder(val value: Int, val list: List<Int>())
+     *
+     * // Holder serialize method
+     * fun serialize(encoder: Encoder, value: Holder) {
+     *     // Completely okay, the whole Holder object is read
+     *     val cborObject = CborMap(...) // build a CborMap from Holder
+     *     (encoder as CborEncoder).encodeCborElement(cborObject) // Write it
+     * }
+     *
+     * // Incorrect Holder serialize method
+     * fun serialize(encoder: Encoder, value: Holder) {
+     *     val composite = encoder.beginStructure(descriptor)
+     *     composite.encodeSerializableElement(descriptor, 0, Int.serializer(), value.value)
+     *     val array = CborList(value.list.map { CborInt(it.toLong()) })
+     *     // Incorrect, encoder is already in an intermediate state after encodeSerializableElement
+     *     (composite as CborEncoder).encodeCborElement(array)
+     *     composite.endStructure(descriptor)
+     *     // ...
+     * }
+     * ```
+     */
+    public fun encodeCborElement(element: CborElement): Unit = encodeSerializableValue(CborElementSerializer, element)
 }

formats/cbor/commonTest/src/kotlinx/serialization/cbor/CborElementTest.kt

@@ -180,6 +180,11 @@ class CborElementTest {
             )
         )
         val mapBytes = cbor.encodeToByteArray(mapElement)
+
+        val output = ByteArrayOutput()
+        IndefiniteLengthCborWriter(cbor, output).encodeCborElement(mapElement)
+        assertEquals(mapBytes.toHexString(),output.toByteArray().toHexString() )
+
         val decodedMap = cbor.decodeFromByteArray<CborElement>(mapBytes)
 
         // Verify the type and size