serde/aws.smithy.kotlin.runtime.serde

Package-level declarations

Types

Exception class for all deserialization errors

Deserializer is a format agnostic deserialization interface. Specific formats (e.g. JSON, XML, etc) implement this interface and handle the underlying raw decoding process and deal with details specific to that format.

FieldTrait

interface FieldTrait

This tag interface provides a mechanism to attach type-specific metadata to any field. See aws.smithy.kotlin.runtime.serde.xml.XmlList for an example implementation.

ListSerializer

interface ListSerializer : PrimitiveSerializer

Serializes a list.

MapSerializer

interface MapSerializer : PrimitiveSerializer

Serializes a map. In Smithy, keys in maps are always Strings.

PrimitiveDeserializer

interface PrimitiveDeserializer

Common interface for deserializing primitive values

PrimitiveSerializer

interface PrimitiveSerializer

Used to serialize primitive values.

SdkFieldDescriptor

open class SdkFieldDescriptor(val kind: SerialKind, var index: Int = 0, val traits: Set<FieldTrait> = emptySet())

Metadata to describe how a given member property maps to serialization.

SdkObjectDescriptor

class SdkObjectDescriptor : SdkFieldDescriptor

Metadata container for all fields of an object/class

SdkSerializable

interface SdkSerializable

SerializationException

class SerializationException

Exception class for all serialization errors

SerializeFn

typealias SerializeFn<T> = (serializer: Serializer, input: T) -> Unit

Serializer

interface Serializer : PrimitiveSerializer

SerialKind

sealed class SerialKind

A protocol-agnostic type description of a field.

SparseValues

object SparseValues : FieldTrait

Denotes that a Map or List may contain null values Details at https://awslabs.github.io/smithy/1.0/spec/core/type-refinement-traits.html#sparse-trait

StructSerializer

interface StructSerializer : PrimitiveSerializer

Functions

asSdkSerializable

fun <T> asSdkSerializable(input: T, serializeFn: SerializeFn<T>): SdkSerializable

Inherited functions

deserializeList

inline fun <T> Deserializer.deserializeList(descriptor: SdkFieldDescriptor, block: Deserializer.ElementIterator.() -> T): T

deserializeMap

inline fun <T> Deserializer.deserializeMap(descriptor: SdkFieldDescriptor, block: Deserializer.EntryIterator.() -> T): T

deserializeStruct

inline fun Deserializer.deserializeStruct(descriptor: SdkObjectDescriptor, block: Deserializer.FieldIterator.() -> Unit)

expectTrait

inline fun <TExpected : FieldTrait> SdkFieldDescriptor.expectTrait(): TExpected

Returns the singleton instance of required Trait, or IllegalArgumentException if does not exist.

field

fun <T> StructSerializer.field(descriptor: SdkFieldDescriptor, input: T, serializeFn: SerializeFn<T>)

findTrait

inline fun <TExpected : FieldTrait> SdkFieldDescriptor.findTrait(): TExpected?

findTraits

inline fun <TExpected : FieldTrait> SdkFieldDescriptor.findTraits(): Set<TExpected>

Find a set of traits of the given type.

getOrDeserializeErr

inline fun <T> <Error class: unknown class><T>.getOrDeserializeErr(errorMessage: () -> String): T

Get the underlying Result.isSuccess value or wrap the failure in a DeserializationException and throw it.

hasTrait

inline fun <TExpected : FieldTrait> SdkFieldDescriptor.hasTrait(): Boolean

parse

inline fun <T> <Error class: unknown class><String>.parse(transform: (String) -> T): <Error class: unknown class><T>

inline fun <T> String.parse(transform: (String) -> T): <Error class: unknown class><T>

parseBigDecimal

fun <Error class: unknown class><String>.parseBigDecimal(): <Error class: unknown class><<Error class: unknown class>>

fun String.parseBigDecimal(): <Error class: unknown class><<Error class: unknown class>>

parseBigInteger

fun <Error class: unknown class><String>.parseBigInteger(): <Error class: unknown class><<Error class: unknown class>>

fun String.parseBigInteger(): <Error class: unknown class><<Error class: unknown class>>

parseBoolean

fun <Error class: unknown class><String>.parseBoolean(): <Error class: unknown class><Boolean>

fun String.parseBoolean(): <Error class: unknown class><Boolean>

parseByte

fun <Error class: unknown class><String>.parseByte(): <Error class: unknown class><Byte>

fun String.parseByte(): <Error class: unknown class><Byte>

parseDouble

fun <Error class: unknown class><String>.parseDouble(): <Error class: unknown class><Double>

fun String.parseDouble(): <Error class: unknown class><Double>

parseFloat

fun <Error class: unknown class><String>.parseFloat(): <Error class: unknown class><Float>

fun String.parseFloat(): <Error class: unknown class><Float>

parseInt

fun <Error class: unknown class><String>.parseInt(): <Error class: unknown class><Int>

fun String.parseInt(): <Error class: unknown class><Int>

parseLong

fun <Error class: unknown class><String>.parseLong(): <Error class: unknown class><Long>

fun String.parseLong(): <Error class: unknown class><Long>

parseShort

fun <Error class: unknown class><String>.parseShort(): <Error class: unknown class><Short>

fun String.parseShort(): <Error class: unknown class><Short>

parseTimestamp

fun <Error class: unknown class><String>.parseTimestamp(fmt: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>>

fun String.parseTimestamp(fmt: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>>

serializeList

inline fun Serializer.serializeList(sdkFieldDescriptor: SdkFieldDescriptor, crossinline block: ListSerializer.() -> Unit)

All elements of a list are expected to be serialized in the given block.

serializeMap

inline fun Serializer.serializeMap(sdkFieldDescriptor: SdkFieldDescriptor, crossinline block: MapSerializer.() -> Unit)

All entries of a map are expected to be serialized in the given block.

serializeStruct

inline fun Serializer.serializeStruct(sdkFieldDescriptor: SdkFieldDescriptor, crossinline block: StructSerializer.() -> Unit)

All components of a struct are expected to be serialized in the given block.