ugorji

README

go-codec

This repository contains the go-codec library, the codecgen tool and benchmarks for comparing against other libraries.

This is a High Performance, Feature-Rich Idiomatic Go 1.4+ codec/encoding library for binary and text formats: binc, msgpack, cbor, json and simple.

It fully supports the legacy GOPATH and the new go modules modes.

Code Organization and Module Support

This repository consists of 4 modules:

• github.com/ugorji/go (requires github.com/ugorji/go/codec)
• github.com/ugorji/go/codec (requires github.com/ugorji/go) README
• github.com/ugorji/go/codec/codecgen (requires github.com/ugorji/go/codec) README
• github.com/ugorji/go/codec/bench (requires github.com/ugorji/go/codec) README

For encoding and decoding, the github.com/ugorji/go/codec module is sufficient.

To install:

go get github.com/ugorji/go/codec

The other modules exist for specific uses, and all require github.com/ugorji/go/codec

• github.com/ugorji/go is here for historical compatibility reasons, as modules was initially introduced only at repo root
• github.com/ugorji/go/codec/codecgen generates high performance static encoders/decoders for given types
• github.com/ugorji/go/codec/bench benchmarks codec against other popular go libraries