protobuf-kotlin-serialization/pro.felixo.protobuf.serialization

Package-level declarations

Types

class EncodingSchema(val serializersModule: SerializersModule, val types: Map<String, Type>) : BinaryFormat

A BinaryFormat for encoding and decoding protobuf messages. Applications should obtain instances of this class using the encodingSchema function.

Enum

class Enum(val name: Identifier, val values: List<EnumValue>) : Type

Field

class Field(val name: Identifier, val encoding: FieldEncoding, val number: FieldNumber, val rule: FieldRule = FieldRule.Singular, val encoder: (WireBuffer) -> Encoder, val decoder: (List<WireValue>) -> Decoder) : Member

IntegerType

enum IntegerType : Enum<IntegerType>

Member

sealed interface Member

Message

class Message(val name: Identifier, val members: List<Member> = emptyList(), val nestedTypes: List<Type> = emptyList(), val encoder: (output: WireBuffer, fieldNumber: FieldNumber?, encodeZeroValue: Boolean) -> HybridEncoder, val decoder: (value: List<WireValue>) -> HybridDecoder) : Type

OneOf

class OneOf(val name: Identifier, val fields: List<Field>) : Member

ProtoDefaultEnumValue

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class ProtoDefaultEnumValue

ProtoIntegerType

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class ProtoIntegerType(val type: IntegerType)

ProtoListItem

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class ProtoListItem(val integerType: IntegerType = IntegerType.Default, val messageName: String = "", val fieldName: String = "value", val fieldNumber: Int = 1)

ProtoMapEntry

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class ProtoMapEntry(val messageName: String = "", val keyName: String = "key", val keyNumber: Int = 1, val keyIntegerType: IntegerType = IntegerType.Default, val valueName: String = "value", val valueNumber: Int = 2, val valueIntegerType: IntegerType = IntegerType.Default)

ProtoNumber

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.CLASS])

annotation class ProtoNumber(val number: Int)

Type

sealed class Type

Functions

toSchemaDocument

fun EncodingSchema.toSchemaDocument(): SchemaDocument

Converts an EncodingSchema to a SchemaDocument, which may be serialized using SchemaDocumentWriter, validated using validate, and compared with other SchemaDocuments.