Docs: Add decodeSequentially possible skipping decodeElementIndex (#1924

)
Kotlin · May 4, 2022 · ce8b05f · ce8b05f
1 parent 7848924
commit ce8b05f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/core/commonMain/src/kotlinx/serialization/encoding/Decoding.kt b/core/commonMain/src/kotlinx/serialization/encoding/Decoding.kt
@@ -411,6 +411,8 @@ public interface CompositeDecoder {
      *     return descriptor.getElementIndex(nextKey) // getElementIndex can return UNKNOWN_NAME
      * }
      * ```
+     *
+     * If [decodeSequentially] returns `true`, the caller might skip calling this method.
      */
     public fun decodeElementIndex(descriptor: SerialDescriptor): Int