serde-json/aws.smithy.kotlin.runtime.serde.json

Package-level declarations

Types

IgnoreKey

data class IgnoreKey(val key: String)

Indicates to deserializers to ignore field/key

JsonDeserializer

class JsonDeserializer(payload: ByteArray)

Provides a deserializer for JSON documents

JsonSerializer

class JsonSerializer

JsonSerialName

data class JsonSerialName(val name: String)

Specifies a name that a field is encoded into for Json elements.

JsonStreamReader

interface JsonStreamReader

Interface for deserializing JSON documents as a stream of tokens

JsonStreamWriter

interface JsonStreamWriter

Interface for serialization. Specific formats should implement this interface according to their own requirements. Currently only aws.smithy.kotlin.runtime.serde.json.JsonSerializer implements this interface.

JsonToken

sealed class JsonToken

Raw tokens produced when reading a JSON document as a stream

Inherited properties

serialName

val <Error class: unknown class>.serialName: String

Provides the serialized name of the field.

Functions

jsonStreamReader

fun jsonStreamReader(payload: ByteArray): JsonStreamReader

jsonStreamWriter

fun jsonStreamWriter(pretty: Boolean = false): JsonStreamWriter

Creates a JsonStreamWriter instance to write JSON

requireToken

inline fun <TExpected> requireToken(token: JsonToken)

Require that the given token be of type TExpected or else throw an exception

Inherited functions

nextTokenOf

inline fun <TExpected : JsonToken> JsonStreamReader.nextTokenOf(): TExpected

Return the next token and require that it be of type TExpected or else throw an exception