serialization-kotlinx/io.buszi.boomerang.serialization.kotlinx/BoomerangFormat/Companion

Companion

object Companion : BoomerangFormat(source)

Default singleton-format and a lightweight builder API.

You can configure a custom instance via BoomerangFormat { ... } and assign it to BoomerangConfig.format to affect the extension helpers in this module.

Types

Builder

class Builder

Builder used by BoomerangFormat { ... } for configuring a custom instance.

Properties

serializersModule

val serializersModule: SerializersModule

The Kotlinx Serialization SerializersModule used for resolving contextual, polymorphic, and custom serializers during encode/decode. Defaults to EmptySerializersModule.

Functions

deserialize

inline fun <T : Any> deserialize(boomerang: Boomerang): T

Deserializes a value of type T from the provided boomerang.

invoke

operator fun invoke(block: BoomerangFormat.Companion.Builder.() -> Unit): BoomerangFormat

Creates a new BoomerangFormat using the provided block to configure Builder options.

serialize

inline fun <T : Any> serialize(value: T): Boomerang

Serializes the given value of type T into a Boomerang.