Cosmic-Binary-Format

cosmic-binary-format/xyz.xenondevs.cbf.serializer/VersionedBinarySerializer

VersionedBinarySerializer

abstract class VersionedBinarySerializer<T : Any>(currentVersion: UByte) : BinarySerializer<T>

A BinarySerializer for a versioned format of T, supporting nulls. Every value is prefixed with an unsigned byte, where 0 indicates a null value and any other value indicates a non-null value in a specific version. A VersionedBinarySerializer can only write data in the current version, but can also read data serialized in previous versions.

Parameters

currentVersion

The current version of the format, i.e. the unsigned byte that will be written on serialization.

Constructors

VersionedBinarySerializer

constructor(currentVersion: UByte)

Functions

open override fun copy(obj: T?): T?

Creates a deep copy of obj.

abstract fun copyNonNull(obj: T): T

Creates a deep copy of the given non-null obj.

override fun read(reader: ByteReader): T?

Reads a value of type T? from reader.

fun <T : Any> BinarySerializer<T>.read(bytes: ByteArray, strict: Boolean = true): T?

Reads a value of type T from bytes.

abstract fun readVersioned(version: UByte, reader: ByteReader): T

Reads a non-null value of type T from reader in the specified version.

override fun write(obj: T?, writer: ByteWriter)

Writes the given obj of type T? to writer.

fun <T : Any> BinarySerializer<T>.write(obj: T?): ByteArray

Writes the given obj of type T to a ByteArray.

abstract fun writeVersioned(obj: T, writer: ByteWriter)

Writes the given non-null obj of type T to writer in the current version format.