grpccodec

Documentation

Index

• type Codec
• type Codecs
• type DefaultCodecs
  • func NewDefaultCodecs(d Codec, namedCodecs ...NamedCodec) *DefaultCodecs
  • func (dc *DefaultCodecs) EncodeDecoder(name string) Codec
• type NamedCodec
  • func Op(name string, codec Codec) NamedCodec
• type ProtoJSON
  • func (pj ProtoJSON) DecodeRequest(pb proto.Message, out interface{}) error
  • func (pj ProtoJSON) EncodeResponse(in interface{}, pb proto.Message) error

Types

type Codec

type Codec interface {
	// DecodeRequest converts a proto message to a Go value.
	// It is designed to be used at the server side.
	DecodeRequest(pb proto.Message, out interface{}) error

	// EncodeResponse converts a Go value to a proto message.
	// It is designed to be used at the server side.
	EncodeResponse(in interface{}, pb proto.Message) error
}

Codec is a series of codecs (encoders and decoders) for gRPC requests and responses.

type Codecs

type Codecs interface {
	EncodeDecoder(name string) Codec
}

type DefaultCodecs

type DefaultCodecs struct {
	Codecs map[string]Codec
	// contains filtered or unexported fields
}

func NewDefaultCodecs

func NewDefaultCodecs(d Codec, namedCodecs ...NamedCodec) *DefaultCodecs

func (*DefaultCodecs) EncodeDecoder

func (dc *DefaultCodecs) EncodeDecoder(name string) Codec

type NamedCodec

type NamedCodec struct {
	Name  string
	Codec Codec
}

NamedCodec holds a codec and its corresponding operation name.

func Op

func Op(name string, codec Codec) NamedCodec

Op is a shortcut for creating an instance of NamedCodec.

type ProtoJSON

type ProtoJSON struct{}

func (ProtoJSON) DecodeRequest

func (pj ProtoJSON) DecodeRequest(pb proto.Message, out interface{}) error

func (ProtoJSON) EncodeResponse

func (pj ProtoJSON) EncodeResponse(in interface{}, pb proto.Message) error