common/dev.restate.serde/Serde

Serde

@NullMarked

interface Serde<T> : TypeTag<T>

Interface defining serialization and deserialization of concrete types.

For more info on the serialization stack, and how to customize it, see SerdeFactory.

Implementations MUST be thread safe.

You can create a custom one using using.

Types

JsonSchema

class JsonSchema : Record, Serde.Schema

Schema to be serialized using internal Jackson mapper.

Schema

interface Schema

StringifiedJsonSchema

class StringifiedJsonSchema : Record, Serde.Schema

Schema already serialized to String.

Properties

RAW

val RAW: Serde<Array<Byte>>

Pass through Serde for byte array.

SLICE

val SLICE: Serde<Slice>

Passthrough serializer/deserializer

VOID

val VOID: Serde<@Nullable Void>

Noop Serde for void.

Functions

contentType

@Nullable

open fun contentType(): @Nullable String

Content-type to use in request/responses.

deserialize

abstract fun deserialize(value: Slice): T

jsonSchema

@Nullable

open fun jsonSchema(): @Nullable Serde.Schema

open fun <T> of(serde: Serde<T>): TypeTag<T>

open fun <T> of(type: TypeRef<T>): TypeTag<T>

open fun <T> of(type: Class<T>): TypeTag<T>

Create a TypeTag from a java.lang.Class.

serialize

abstract fun serialize(value: T): Slice

using

open fun <T> using(serializer: ThrowingFunction<T, Array<Byte>>, deserializer: ThrowingFunction<Array<Byte>, T>): Serde<@NonNull T>

Like using, using content-type


application/octet-stream

open fun <T> using(contentType: String, serializer: ThrowingFunction<T, Array<Byte>>, deserializer: ThrowingFunction<Array<Byte>, T>): Serde<@NonNull T>

Create a Serde from serializer/deserializer lambdas, tagging with contentType.

withContentType

open fun <T> withContentType(contentType: String, inner: Serde<T>): Serde<T>

Serde

See also

Types

Properties

Functions