pimp CborEncoder

Author: JesusMcCloud

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

@@ -115,6 +115,9 @@ 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 encodeNegative-VKZWuLQ (J)V
+	public abstract fun encodePositive-VKZWuLQ (J)V
+	public abstract fun encodeTags-QwZRm1k ([J)V
 	public abstract fun getCbor ()Lkotlinx/serialization/cbor/Cbor;
 }
 

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

@@ -53,6 +53,9 @@ abstract interface kotlinx.serialization.cbor/CborEncoder : kotlinx.serializatio
     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]
 
+    abstract fun encodeNegative(kotlin/ULong) // kotlinx.serialization.cbor/CborEncoder.encodeNegative|encodeNegative(kotlin.ULong){}[0]
+    abstract fun encodePositive(kotlin/ULong) // kotlinx.serialization.cbor/CborEncoder.encodePositive|encodePositive(kotlin.ULong){}[0]
+    abstract fun encodeTags(kotlin/ULongArray) // kotlinx.serialization.cbor/CborEncoder.encodeTags|encodeTags(kotlin.ULongArray){}[0]
     open fun encodeCborElement(kotlinx.serialization.cbor/CborElement) // kotlinx.serialization.cbor/CborEncoder.encodeCborElement|encodeCborElement(kotlinx.serialization.cbor.CborElement){}[0]
 }
 

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

@@ -6,6 +6,8 @@ package kotlinx.serialization.cbor
 
 import kotlinx.serialization.*
 import kotlinx.serialization.cbor.internal.CborElementSerializer
+import kotlinx.serialization.cbor.internal.encodeNegative
+import kotlinx.serialization.cbor.internal.encodePositive
 import kotlinx.serialization.encoding.*
 
 /**
@@ -61,4 +63,19 @@ public interface CborEncoder : Encoder {
      * ```
      */
     public fun encodeCborElement(element: CborElement): Unit = encodeSerializableValue(CborElementSerializer, element)
+
+    /**
+     * Allows manually encoding CBOR tags. Use with caution, as it is possible to produce invalid CBOR if invoked carelessly!
+     */
+    public fun encodeTags(@OptIn(kotlin.ExperimentalUnsignedTypes::class) tags: ULongArray): Unit
+
+    /**
+     * Encode a negative value as [CborInt]. This function exists to encode negative values exceeding [Long.MIN_VALUE]
+     */
+    public fun encodeNegative(value: ULong)
+
+    /**
+     * Encode a positive value as [CborInt]. This function exists to encode negative values exceeding [Long.MAX_VALUE]
+     */
+    public fun encodePositive(value: ULong)
 }

formats/cbor/commonMain/src/kotlinx/serialization/cbor/internal/CborElementSerializers.kt

@@ -86,7 +86,7 @@ internal object CborNullSerializer : KSerializer<CborNull>, CborSerializer {
 
     override fun serialize(encoder: Encoder, value: CborNull) {
         val cborEncoder = encoder.asCborEncoder()
-        cborEncoder.encodeTags(value)
+        cborEncoder.encodeTags(value.tags)
         encoder.encodeNull()
     }
 
@@ -108,7 +108,7 @@ internal object CborIntSerializer : KSerializer<CborInt>, CborSerializer {
 
     override fun serialize(encoder: Encoder, value: CborInt) {
         val cborEncoder = encoder.asCborEncoder()
-        cborEncoder.encodeTags(value)
+        cborEncoder.encodeTags(value.tags)
         when (value.sign) {
             //@formatter:off
             CborInt.Sign.ZERO, CborInt.Sign.POSITIVE -> cborEncoder.encodePositive(value.value)
@@ -130,7 +130,7 @@ internal object CborFloatSerializer : KSerializer<CborFloat>, CborSerializer {
 
     override fun serialize(encoder: Encoder, value: CborFloat) {
         val cborEncoder = encoder.asCborEncoder()
-        cborEncoder.encodeTags(value)
+        cborEncoder.encodeTags(value.tags)
         encoder.encodeDouble(value.value)
     }
 
@@ -150,7 +150,7 @@ internal object CborStringSerializer : KSerializer<CborString>, CborSerializer {
 
     override fun serialize(encoder: Encoder, value: CborString) {
         val cborEncoder = encoder.asCborEncoder()
-        cborEncoder.encodeTags(value)
+        cborEncoder.encodeTags(value.tags)
         encoder.encodeString(value.value)
     }
 
@@ -172,7 +172,7 @@ internal object CborBooleanSerializer : KSerializer<CborBoolean>, CborSerializer
 
     override fun serialize(encoder: Encoder, value: CborBoolean) {
         val cborEncoder = encoder.asCborEncoder()
-        cborEncoder.encodeTags(value)
+        cborEncoder.encodeTags(value.tags)
         encoder.encodeBoolean(value.value)
     }
 
@@ -194,8 +194,9 @@ internal object CborByteStringSerializer : KSerializer<CborByteString>, CborSeri
 
     override fun serialize(encoder: Encoder, value: CborByteString) {
         val cborEncoder = encoder.asCborEncoder()
-        cborEncoder.encodeTags(value)
-        cborEncoder.encodeByteString(value.value)
+        cborEncoder.encodeTags(value.tags)
+        //this we really don't want to expose so we cast here
+        (cborEncoder as CborWriter).encodeByteString(value.value)
     }
 
     override fun deserialize(decoder: Decoder): CborByteString {
@@ -221,7 +222,7 @@ internal object CborMapSerializer : KSerializer<CborMap>, CborSerializer {
 
     override fun serialize(encoder: Encoder, value: CborMap) {
         val cborEncoder = encoder.asCborEncoder()
-        cborEncoder.encodeTags(value)
+        cborEncoder.encodeTags(value.tags)
         MapSerializer(CborElementSerializer, CborElementSerializer).serialize(encoder, value)
     }
 
@@ -245,7 +246,7 @@ internal object CborListSerializer : KSerializer<CborList>, CborSerializer {
 
     override fun serialize(encoder: Encoder, value: CborList) {
         val cborEncoder = encoder.asCborEncoder()
-        cborEncoder.encodeTags(value)
+        cborEncoder.encodeTags(value.tags)
         ListSerializer(CborElementSerializer).serialize(encoder, value)
     }
 
@@ -263,7 +264,7 @@ internal fun Decoder.asCborDecoder(): CborDecoder = this as? CborDecoder
     )
 
 /*need to expose writer to access encodeTag()*/
-internal fun Encoder.asCborEncoder() = this as? CborWriter
+internal fun Encoder.asCborEncoder() = this as? CborEncoder
     ?: throw IllegalStateException(
         "This serializer can be used only with Cbor format." +
             "Expected Encoder to be CborEncoder, got ${this::class}"

formats/cbor/commonMain/src/kotlinx/serialization/cbor/internal/Encoder.kt

@@ -99,8 +99,8 @@ internal sealed class CborWriter(
     override fun encodeLong(value: Long) {
         getDestination().encodeNumber(value)
     }
-    internal open fun encodeNegative(value: ULong) = getDestination().encodeNegative(value)
-    internal open fun encodePositive(value: ULong) = getDestination().encodePositive(value)
+    override fun encodeNegative(value: ULong) = getDestination().encodeNegative(value)
+    override fun encodePositive(value: ULong) = getDestination().encodePositive(value)
 
     override fun encodeBoolean(value: Boolean) {
         getDestination().encodeBoolean(value)
@@ -148,8 +148,6 @@ internal sealed class CborWriter(
         incrementChildren() // needed for definite len encoding, NOOP for indefinite length encoding
         return true
     }
-
-    internal abstract fun encodeTags(tags: ULongArray)
 }