polishing

Author: JesusMcCloud

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

@@ -36,7 +36,7 @@ public interface CborDecoder : Decoder {
      * Decodes the next element in the current input as [CborElement].
      * The type of the decoded element depends on the current state of the input and, when received
      * by [serializer][KSerializer] in its [KSerializer.serialize] method, the type of the token directly matches
-     * the [kind][SerialDescriptor.kind].
+     * the [kind][kotlinx.serialization.descriptors.SerialDescriptor.kind].
      *
      * This method is allowed to invoke only as the part of the whole deserialization process of the class,
      * calling this method after invoking [beginStructure] or any `decode*` method will lead to unspecified behaviour.

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

@@ -595,7 +595,7 @@ internal class StructuredCborParser(internal val element: CborElement, private v
         isMap = false
         val list = currentElement as CborList
         listIterator = list.listIterator()
-        return -1 //just let the iterator run out of elements
+        return list.size
     }
 
     override fun startMap(tags: ULongArray?): Int {
@@ -608,9 +608,10 @@ internal class StructuredCborParser(internal val element: CborElement, private v
         isMap = true
 
         val map = currentElement as CborMap
-        //zip key, value, key, value, ... pairs to mirror byte-layout of CBOR map
+        // zip key, value, key, value, ... pairs to mirror byte-layout of CBOR map, so decoding this here works the same
+        // as decoding from bytes
         listIterator = map.entries.flatMap { listOf(it.key, it.value) }.listIterator()
-        return -1// just let the iterator run out of elements
+        return map.size
     }
 
     override fun nextNull(tags: ULongArray?): Nothing? {
@@ -677,9 +678,14 @@ internal class StructuredCborParser(internal val element: CborElement, private v
         }
     }
 
+    /**
+     * Verify the current element's object tags and advance to the next element if inside a list/map.
+     * The reason this method mixes two behaviours is that decoding a primitive is invoked on a single element.
+     * `decodeElementIndex`, etc. is invoked on an iterable and there are key tags and value tags
+     */
     private fun processTags(tags: ULongArray?): ULongArray? {
 
-        // If we're in a list, advance to the next element
+        // If we're in a list/map, advance to the next element
         if (listIterator != null && listIterator!!.hasNext()) {
             currentElement = listIterator!!.next()
         }
@@ -707,7 +713,6 @@ internal class StructuredCborParser(internal val element: CborElement, private v
 
     override fun skipElement(tags: ULongArray?) {
         // Process tags but don't do anything with the element
-        //TODO check for maps
         processTags(tags)
     }
 }