types/kotools.types.collection/NotEmptyMap

NotEmptyMap

@JvmInline

@Serializable(with = NotEmptyMapSerializer::class)

@Since(version = KotoolsTypesVersion.V4_0_0)

value class NotEmptyMap<K, out V>

Represents a map that has at least one entry, with a key of type K and a value of type V.

You can use the notEmptyMapOf or the toNotEmptyMap functions for creating an instance of this type.

Serialization and deserialization

The serialization and deserialization processes of this type behave like for the Map type.

Here's an example of Kotlin code that encodes and decodes this type using the JavaScript Object Notation (JSON) format from kotlinx.serialization:

val map: NotEmptyMap<Char, Int> = notEmptyMapOf('a' to 1, 'b' to 2)
val encoded: String = Json.encodeToString(map)
assertEquals(expected = "{\"a\":1,\"b\":2}", actual = encoded)
val decoded: NotEmptyMap<Char, Int> = Json.decodeFromString(encoded)
assertEquals(expected = map, actual = decoded)