protoconv

Documentation

Overview

Package protoconv provides a mechanism to register functions to convert objects to and from proto messages.

Index

• func Register(toProto, toObject interface{})
• func ToObject(ctx context.Context, msg proto.Message) (interface{}, error)
• func ToProto(ctx context.Context, obj interface{}) (proto.Message, error)
• type ErrNoConverterRegistered
  • func (e ErrNoConverterRegistered) Error() string

Functions

func Register

func Register(toProto, toObject interface{})

Register registers the converters toProto and toObject. toProto must be a function with the signature:

func(context.Context, O) (P, error)

toObject must be a function with the signature:

func(context.Context, P) (O, error)

Where P is the proto message type and O is the object type.

func ToObject

func ToObject(ctx context.Context, msg proto.Message) (interface{}, error)

ToObject converts obj to a proto message using the converter registered with Register.

func ToProto

func ToProto(ctx context.Context, obj interface{}) (proto.Message, error)

ToProto converts obj to a proto message using the converter registered with Register.

Types

type ErrNoConverterRegistered

type ErrNoConverterRegistered struct {
	Object interface{}
}

ErrNoConverterRegistered is the error returned from ToProto or ToObject when the object's type is not registered for conversion.

func (ErrNoConverterRegistered) Error

func (e ErrNoConverterRegistered) Error() string