SerializerCodec¶

class SerializerCodec<X>(serializer: KSerializer<X>) : Codec<X>

Constructors¶

SerializerCodec¶

constructor(serializer: KSerializer<X>)

Functions¶

`boxed`¶

open fun boxed(): Decoder.Boxed<X?>?

`comap`¶

open fun <B : Any?> comap(function: Function<in B?, out X?>?): Encoder<B?>?

`comapFlatMap`¶

open fun <S : Any?> comapFlatMap(to: Function<in X?, out DataResult<out S?>?>?, from: Function<in S?, out X?>?): Codec<S?>?

`decode`¶

open fun <T : Any?> decode(input: Dynamic<T?>?): DataResult<Pair<X?, T?>?>?

open override fun <T> decode(ops: DynamicOps<T>, input: T): DataResult<Pair<X, T>>

`deprecated`¶

open fun deprecated(since: Int): Codec<X?>?

`dispatch`¶

open fun <E : Any?> dispatch(type: Function<in E?, out X?>?, codec: Function<in X?, out MapCodec<out E?>?>?): Codec<E?>?

open fun <E : Any?> dispatch(
    typeKey: String?, 
    type: Function<in E?, out X?>?, 
    codec: Function<in X?, out MapCodec<out E?>?>?
): Codec<E?>?

`dispatchMap`¶

open fun <E : Any?> dispatchMap(type: Function<in E?, out X?>?, codec: Function<in X?, out MapCodec<out E?>?>?): MapCodec<E?>?

open fun <E : Any?> dispatchMap(
    typeKey: String?, 
    type: Function<in E?, out X?>?, 
    codec: Function<in X?, out MapCodec<out E?>?>?
): MapCodec<E?>?

`dispatchStable`¶

open fun <E : Any?> dispatchStable(type: Function<in E?, out X?>?, codec: Function<in X?, out MapCodec<out E?>?>?): Codec<E?>?

encode¶

open override fun <T : Any> encode(
    input: X, 
    ops: DynamicOps<T>, 
    prefix: T
): DataResult<T>

`encodeStart`¶

open fun <T : Any?> encodeStart(ops: DynamicOps<T?>?, input: X?): DataResult<T?>?

`fieldOf`¶

open fun fieldOf(name: String?): MapCodec<X?>?

`flatComap`¶

open fun <B : Any?> flatComap(function: Function<in B?, out DataResult<out X?>?>?): Encoder<B?>?

`flatComapMap`¶

open fun <S : Any?> flatComapMap(to: Function<in X?, out S?>?, from: Function<in S?, out DataResult<out X?>?>?): Codec<S?>?

`flatMap`¶

open fun <B : Any?> flatMap(function: Function<in X?, out DataResult<out B?>?>?): Decoder<B?>?

`flatXmap`¶

open fun <S : Any?> flatXmap(to: Function<in X?, out DataResult<out S?>?>?, from: Function<in S?, out DataResult<out X?>?>?): Codec<S?>?

`lenientOptionalFieldOf`¶

open fun lenientOptionalFieldOf(name: String?): MapCodec<Optional<X?>?>?

open fun lenientOptionalFieldOf(name: String?, defaultValue: X?): MapCodec<X?>?

open fun lenientOptionalFieldOf(
    name: String?, 
    defaultValue: X?, 
    lifecycleOfDefault: Lifecycle?
): MapCodec<X?>?

open fun lenientOptionalFieldOf(
    name: String?, 
    fieldLifecycle: Lifecycle?, 
    defaultValue: X?, 
    lifecycleOfDefault: Lifecycle?
): MapCodec<X?>?

`listOf`¶

open fun listOf(): Codec<List<X?>?>?

open fun listOf(minSize: Int, maxSize: Int): Codec<List<X?>?>?

`map`¶

open fun <B : Any?> map(function: Function<in X?, out B?>?): Decoder<B?>?

`mapResult`¶

open fun mapResult(function: Codec.ResultFunction<X?>?): Codec<X?>?

`optionalFieldOf`¶

open fun optionalFieldOf(name: String?): MapCodec<Optional<X?>?>?

open fun optionalFieldOf(name: String?, defaultValue: X?): MapCodec<X?>?

open fun optionalFieldOf(
    name: String?, 
    defaultValue: X?, 
    lifecycleOfDefault: Lifecycle?
): MapCodec<X?>?

open fun optionalFieldOf(
    name: String?, 
    fieldLifecycle: Lifecycle?, 
    defaultValue: X?, 
    lifecycleOfDefault: Lifecycle?
): MapCodec<X?>?

`orElse`¶

open fun orElse(value: X?): Codec<X?>?

open fun orElse(onError: Consumer<String?>?, value: X?): Codec<X?>?

open fun orElse(onError: UnaryOperator<String?>?, value: X?): Codec<X?>?

`orElseGet`¶

open fun orElseGet(value: Supplier<out X?>?): Codec<X?>?

open fun orElseGet(onError: Consumer<String?>?, value: Supplier<out X?>?): Codec<X?>?

open fun orElseGet(onError: UnaryOperator<String?>?, value: Supplier<out X?>?): Codec<X?>?

`parse`¶

open fun <T : Any?> parse(input: Dynamic<T?>?): DataResult<X?>?

open fun <T : Any?> parse(ops: DynamicOps<T?>?, input: T?): DataResult<X?>?

`partialDispatch`¶

open fun <E : Any?> partialDispatch(
    typeKey: String?, 
    type: Function<in E?, out DataResult<out X?>?>?, 
    codec: Function<in X?, out DataResult<out MapCodec<out E?>?>?>?
): Codec<E?>?

`promotePartial`¶

open fun promotePartial(onError: Consumer<String?>?): Codec<X?>?

serializer¶

inline fun <T> Codec<T>.serializer(): KSerializer<T>

Converts this Codec into a KSerializer backed by CodecSerializer.

Supports JSON, TOML, and NBT serialization contexts.

`simple`¶

open fun simple(): Decoder.Simple<X?>?

`sizeLimitedListOf`¶

open fun sizeLimitedListOf(maxSize: Int): Codec<List<X?>?>?

`stable`¶

open fun stable(): Codec<X?>?

`terminal`¶

open fun terminal(): Decoder.Terminal<X?>?

`validate`¶

open fun validate(checker: Function<X?, DataResult<X?>?>?): Codec<X?>?

`withLifecycle`¶

open fun withLifecycle(lifecycle: Lifecycle?): Codec<X?>?

`xmap`¶

open fun <S : Any?> xmap(to: Function<in X?, out S?>?, from: Function<in S?, out X?>?): Codec<S?>?