kotlinx-serialization / kotlinx.serialization.protobuf

Package kotlinx.serialization.protobuf

Protocol buffers serialization format implementation, mostly complaint to proto2 specification. Located in separate kotlinx-serialization-protobuf artifact.

Types

(common, js, jvm, native)

ProtoBuf

Implements encoding and decoding classes to/from bytes using Proto2 specification. It is typically used by constructing an application-specific instance, with configured specific behaviour and, if necessary, registered custom serializers (in SerialModule provided by context constructor parameter).

class ProtoBuf : BinaryFormat
(common, js, jvm, native)

ProtoNumberType

Represents a number format in protobuf encoding.

enum class ProtoNumberType

Annotations

(common, js, jvm, native)

ProtoId

Specifies protobuf id (a unique number for a field in the protobuf message) assigned to a Kotlin property.

annotation class ProtoId
(common, js, jvm, native)

ProtoType

Instructs to use a particular ProtoNumberType for a property of integer number type. Affect Byte, Short, Int, Long and Char properties and does not affect others.

annotation class ProtoType

Exceptions

(common, js, jvm, native)

ProtobufDecodingException

 class ProtobufDecodingException : SerializationException