protobuf

Documentation

Index

• type Deserializer
  • func NewDeserializer(client schemaregistry.Client, serdeType serde.Type, conf *DeserializerConfig) (*Deserializer, error)
  • func (s *Deserializer) ConfigureDeserializer(client schemaregistry.Client, serdeType serde.Type, ...) error
  • func (s *Deserializer) Deserialize(topic string, payload []byte) (interface{}, error)
  • func (s *Deserializer) DeserializeInto(topic string, payload []byte, msg interface{}) error
• type DeserializerConfig
  • func NewDeserializerConfig() *DeserializerConfig
• type Serde
  • func (s *Serde) FieldTransform(client schemaregistry.Client, ctx serde.RuleContext, ...) (interface{}, error)
• type Serializer
  • func NewSerializer(client schemaregistry.Client, serdeType serde.Type, conf *SerializerConfig) (*Serializer, error)
  • func (s *Serializer) Serialize(topic string, msg interface{}) ([]byte, error)
• type SerializerConfig
  • func NewSerializerConfig() *SerializerConfig

Types

type Deserializer

type Deserializer struct {
	serde.BaseDeserializer
	*Serde
	ProtoRegistry *protoregistry.Types
}

Deserializer represents a Protobuf deserializer

func NewDeserializer

func NewDeserializer(client schemaregistry.Client, serdeType serde.Type, conf *DeserializerConfig) (*Deserializer, error)

NewDeserializer creates a Protobuf deserializer for Protobuf-generated objects

func (*Deserializer) ConfigureDeserializer

func (s *Deserializer) ConfigureDeserializer(client schemaregistry.Client, serdeType serde.Type,
	conf *serde.DeserializerConfig) error

ConfigureDeserializer configures the Protobuf deserializer

func (*Deserializer) Deserialize

func (s *Deserializer) Deserialize(topic string, payload []byte) (interface{}, error)

Deserialize implements deserialization of Protobuf data

func (*Deserializer) DeserializeInto

func (s *Deserializer) DeserializeInto(topic string, payload []byte, msg interface{}) error

DeserializeInto implements deserialization of Protobuf data to the given object

type DeserializerConfig

type DeserializerConfig struct {
	serde.DeserializerConfig
}

DeserializerConfig is used to pass multiple configuration options to the deserializers.

func NewDeserializerConfig

func NewDeserializerConfig() *DeserializerConfig

NewDeserializerConfig returns a new configuration instance with sane defaults.

type Serde

type Serde struct {
	// contains filtered or unexported fields
}

Serde represents a Protobuf serde

func (*Serde) FieldTransform

func (s *Serde) FieldTransform(client schemaregistry.Client, ctx serde.RuleContext, fieldTransform serde.FieldTransform, msg interface{}) (interface{}, error)

FieldTransform transforms the field value using the rule

type Serializer

type Serializer struct {
	serde.BaseSerializer
	*Serde
	Conf *SerializerConfig
	// contains filtered or unexported fields
}

Serializer represents a Protobuf serializer

func NewSerializer

func NewSerializer(client schemaregistry.Client, serdeType serde.Type, conf *SerializerConfig) (*Serializer, error)

NewSerializer creates a Protobuf serializer for Protobuf-generated objects

func (*Serializer) Serialize

func (s *Serializer) Serialize(topic string, msg interface{}) ([]byte, error)

Serialize implements serialization of Protobuf data

type SerializerConfig

type SerializerConfig struct {
	serde.SerializerConfig
	// CacheSchemas will cache serialization results based on the name of the protobuf file
	// corresponding to the message being serialized. This will drastically improve serialization
	// performance if you are only ever using a _single_ version of a specific protobuf schema
	// during any given run of your application. This should be the case for most applications,
	// but might not apply if you're not creating proto messages based on generated files (e.g.
	// you are proxying or reading raw protobuf messages from a data source), or if for some reason
	// you are including multiple versions of the same schema/protobuf in your application.
	CacheSchemas bool
}

SerializerConfig is used to pass multiple configuration options to the serializers.

func NewSerializerConfig

func NewSerializerConfig() *SerializerConfig

NewSerializerConfig returns a new configuration instance with sane defaults.