codec

package

v0.1.0 Latest Latest Go to latest Published: Nov 18, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func EncodingGOB() string

EncodingGOB returns json encoding.

func EncodingJSON() string

EncodingJSON returns json encoding.

func EncodingProto() string

EncodingProto returns json encoding.

func Register(codec Codec) error

Register registers the codec in the mapping.

func TestMessagesEncoding(t *testing.T, codecs []Codec, messages ...interface{})

TestMessagesEncoding tests the input messages if the values encoding persists the same.

type Codec interface {
	Marshal(interface{}) ([]byte, error)
	Unmarshal([]byte, interface{}) error
	Encoding() string
	Name() string
}

Codec is an interface for all codecs to implement the

func GOB() Codec

GOB gets std gob codec.

func Get(encoding string) (Codec, bool)

Get returns a codec for provided encoding name.

func JSON() Codec

JSON gets std json codec implementation.

func Proto() Codec

Proto gets std protobuf codec.

type ProtoMarshaler interface {
	MarshalProto() ([]byte, error)
}

ProtoMarshaler is an interface used by the protobuf codec used to custom marshal proto message.

type ProtoUnmarshaler interface {
	UnmarshalProto([]byte) error
}

ProtoUnmarshaler is an interface used for custom unmarshalling proto message.

Path	Synopsis
internal
pb