JsonDecoder

interface JsonDecoder(source)

Decoder used by Json during deserialization. This interface can be used to inject desired behaviour into a serialization process of Json.

Typical example of the usage:

// Class representing Either<Left|Right>
sealed class Either {
data class Left(val errorMsg: String) : Either()
data class Right(val data: Payload) : Either()
}

// Serializer injects custom behaviour by inspecting object content and writing
object EitherSerializer : KSerializer<Either> {
override val descriptor: SerialDescriptor = buildSerialDescriptor("package.Either", PolymorphicKind.SEALED) {
// ..
}

override fun deserialize(decoder: Decoder): Either {
val input = decoder as? JsonDecoder ?: throw SerializationException("This class can be decoded only by Json format")
val tree = input.decodeJsonElement() as? JsonObject ?: throw SerializationException("Expected JsonObject")
if ("error" in tree) return Either.Left(tree["error"]!!.jsonPrimitive.content)
return Either.Right(input.json.decodeFromJsonElement(Payload.serializer(), tree))
}

override fun serialize(encoder: Encoder, value: Either) {
val output = encoder as? JsonEncoder ?: throw SerializationException("This class can be encoded only by Json format")
val tree = when (value) {
is Either.Left -> JsonObject(mapOf("error" to JsonPrimitive(value.errorMsg)))
is Either.Right -> output.json.encodeToJsonElement(Payload.serializer(), value.data)
}
output.encodeJsonElement(tree)
}
}

Not stable for inheritance

JsonDecoder interface is not stable for inheritance in 3rd party libraries, as new methods might be added to this interface or contracts of the existing methods can be changed. Accepting this interface in your API methods, casting Decoder to JsonDecoder and invoking its methods is considered stable.

Properties

Link copied to clipboard
abstract val json: Json

An instance of the current Json.

Functions

Link copied to clipboard

Decodes the next element in the current input as JsonElement. The type of the decoded element depends on the current state of the input and, when received by KSerializer in its KSerializer.serialize method, the type of the token directly matches the SerialDescriptor.kind.