kotlinx-serialization-protobuf/kotlinx.serialization.protobuf

Package-level declarations

Protocol buffers serialization format implementation.

Types

Implements encoding and decoding classes to/from bytes using Protocol buffers specification. It is typically used by constructing an application-specific instance, with configured specific behavior and, if necessary, registered custom serializers (in SerializersModule provided by serializersModule constructor parameter). Default encoding is proto2, although proto3 can be used with a number of tweaks (see the section below for details).

ProtoBufBuilder

@ExperimentalSerializationApi

class ProtoBufBuilder

Builder of the ProtoBuf instance provided by ProtoBuf factory function.

ProtoIntegerType

@ExperimentalSerializationApi

enum ProtoIntegerType : Enum<ProtoIntegerType>

Represents a number format in protobuf encoding set by ProtoType annotation.

ProtoNumber

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

@ExperimentalSerializationApi

annotation class ProtoNumber(val number: Int)

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

ProtoOneOf

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

@ExperimentalSerializationApi

annotation class ProtoOneOf

Instructs that a particular property should be written as an oneof.

ProtoPacked

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

@ExperimentalSerializationApi

annotation class ProtoPacked

Instructs that a particular collection should be written as a packed array.

ProtoType

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

@ExperimentalSerializationApi

annotation class ProtoType(val type: ProtoIntegerType)

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

Functions

ProtoBuf

@ExperimentalSerializationApi

fun ProtoBuf(from: ProtoBuf = ProtoBuf, builderAction: ProtoBufBuilder.() -> Unit): ProtoBuf

Creates an instance of ProtoBuf configured from the optionally given ProtoBuf instance and adjusted with builderAction.