|
|
@@ -23,11 +23,11 @@ codec/encoding library for binc, msgpack, cbor, json.
|
|
|
|
|
|
Supported Serialization formats are:
|
|
|
|
|
|
- - msgpack: https://github.com/msgpack/msgpack
|
|
|
- - binc: http://github.com/ugorji/binc
|
|
|
- - cbor: http://cbor.io http://tools.ietf.org/html/rfc7049
|
|
|
- - json: http://json.org http://tools.ietf.org/html/rfc7159
|
|
|
- - simple:
|
|
|
+ - msgpack: https://github.com/msgpack/msgpack
|
|
|
+ - binc: http://github.com/ugorji/binc
|
|
|
+ - cbor: http://cbor.io http://tools.ietf.org/html/rfc7049
|
|
|
+ - json: http://json.org http://tools.ietf.org/html/rfc7159
|
|
|
+ - simple:
|
|
|
|
|
|
This package will carefully use 'unsafe' for performance reasons in specific
|
|
|
places. You can build without unsafe use by passing the safe or appengine
|
|
|
@@ -44,56 +44,56 @@ standard library (ie json, xml, gob, etc).
|
|
|
|
|
|
Rich Feature Set includes:
|
|
|
|
|
|
- - Simple but extremely powerful and feature-rich API
|
|
|
- - Support for go1.4 and above, while selectively using newer APIs for later releases
|
|
|
- - Excellent code coverage ( > 90% )
|
|
|
- - Very High Performance.
|
|
|
- Our extensive benchmarks show us outperforming Gob, Json, Bson, etc by 2-4X.
|
|
|
- - Careful selected use of 'unsafe' for targeted performance gains.
|
|
|
- 100% mode exists where 'unsafe' is not used at all.
|
|
|
- - Lock-free (sans mutex) concurrency for scaling to 100's of cores
|
|
|
- - In-place updates during decode, with option to zero value in maps and slices prior to decode
|
|
|
- - Coerce types where appropriate
|
|
|
- e.g. decode an int in the stream into a float, decode numbers from formatted strings, etc
|
|
|
- - Corner Cases:
|
|
|
- Overflows, nil maps/slices, nil values in streams are handled correctly
|
|
|
- - Standard field renaming via tags
|
|
|
- - Support for omitting empty fields during an encoding
|
|
|
- - Encoding from any value and decoding into pointer to any value
|
|
|
- (struct, slice, map, primitives, pointers, interface{}, etc)
|
|
|
- - Extensions to support efficient encoding/decoding of any named types
|
|
|
- - Support encoding.(Binary|Text)(M|Unm)arshaler interfaces
|
|
|
- - Support IsZero() bool to determine if a value is a zero value.
|
|
|
- Analogous to time.Time.IsZero() bool.
|
|
|
- - Decoding without a schema (into a interface{}).
|
|
|
- Includes Options to configure what specific map or slice type to use
|
|
|
- when decoding an encoded list or map into a nil interface{}
|
|
|
- - Mapping a non-interface type to an interface, so we can decode appropriately
|
|
|
- into any interface type with a correctly configured non-interface value.
|
|
|
- - Encode a struct as an array, and decode struct from an array in the data stream
|
|
|
- - Option to encode struct keys as numbers (instead of strings)
|
|
|
- (to support structured streams with fields encoded as numeric codes)
|
|
|
- - Comprehensive support for anonymous fields
|
|
|
- - Fast (no-reflection) encoding/decoding of common maps and slices
|
|
|
- - Code-generation for faster performance.
|
|
|
- - Support binary (e.g. messagepack, cbor) and text (e.g. json) formats
|
|
|
- - Support indefinite-length formats to enable true streaming
|
|
|
- (for formats which support it e.g. json, cbor)
|
|
|
- - Support canonical encoding, where a value is ALWAYS encoded as same sequence of bytes.
|
|
|
- This mostly applies to maps, where iteration order is non-deterministic.
|
|
|
- - NIL in data stream decoded as zero value
|
|
|
- - Never silently skip data when decoding.
|
|
|
- User decides whether to return an error or silently skip data when keys or indexes
|
|
|
- in the data stream do not map to fields in the struct.
|
|
|
- - Detect and error when encoding a cyclic reference (instead of stack overflow shutdown)
|
|
|
- - Encode/Decode from/to chan types (for iterative streaming support)
|
|
|
- - Drop-in replacement for encoding/json. `json:` key in struct tag supported.
|
|
|
- - Provides a RPC Server and Client Codec for net/rpc communication protocol.
|
|
|
- - Handle unique idiosyncrasies of codecs e.g.
|
|
|
- - For messagepack, configure how ambiguities in handling raw bytes are resolved
|
|
|
- - For messagepack, provide rpc server/client codec to support
|
|
|
- msgpack-rpc protocol defined at:
|
|
|
- https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md
|
|
|
+ - Simple but extremely powerful and feature-rich API
|
|
|
+ - Support for go1.4 and above, while selectively using newer APIs for later releases
|
|
|
+ - Excellent code coverage ( > 90% )
|
|
|
+ - Very High Performance.
|
|
|
+ Our extensive benchmarks show us outperforming Gob, Json, Bson, etc by 2-4X.
|
|
|
+ - Careful selected use of 'unsafe' for targeted performance gains.
|
|
|
+ 100% mode exists where 'unsafe' is not used at all.
|
|
|
+ - Lock-free (sans mutex) concurrency for scaling to 100's of cores
|
|
|
+ - In-place updates during decode, with option to zero value in maps and slices prior to decode
|
|
|
+ - Coerce types where appropriate
|
|
|
+ e.g. decode an int in the stream into a float, decode numbers from formatted strings, etc
|
|
|
+ - Corner Cases:
|
|
|
+ Overflows, nil maps/slices, nil values in streams are handled correctly
|
|
|
+ - Standard field renaming via tags
|
|
|
+ - Support for omitting empty fields during an encoding
|
|
|
+ - Encoding from any value and decoding into pointer to any value
|
|
|
+ (struct, slice, map, primitives, pointers, interface{}, etc)
|
|
|
+ - Extensions to support efficient encoding/decoding of any named types
|
|
|
+ - Support encoding.(Binary|Text)(M|Unm)arshaler interfaces
|
|
|
+ - Support IsZero() bool to determine if a value is a zero value.
|
|
|
+ Analogous to time.Time.IsZero() bool.
|
|
|
+ - Decoding without a schema (into a interface{}).
|
|
|
+ Includes Options to configure what specific map or slice type to use
|
|
|
+ when decoding an encoded list or map into a nil interface{}
|
|
|
+ - Mapping a non-interface type to an interface, so we can decode appropriately
|
|
|
+ into any interface type with a correctly configured non-interface value.
|
|
|
+ - Encode a struct as an array, and decode struct from an array in the data stream
|
|
|
+ - Option to encode struct keys as numbers (instead of strings)
|
|
|
+ (to support structured streams with fields encoded as numeric codes)
|
|
|
+ - Comprehensive support for anonymous fields
|
|
|
+ - Fast (no-reflection) encoding/decoding of common maps and slices
|
|
|
+ - Code-generation for faster performance.
|
|
|
+ - Support binary (e.g. messagepack, cbor) and text (e.g. json) formats
|
|
|
+ - Support indefinite-length formats to enable true streaming
|
|
|
+ (for formats which support it e.g. json, cbor)
|
|
|
+ - Support canonical encoding, where a value is ALWAYS encoded as same sequence of bytes.
|
|
|
+ This mostly applies to maps, where iteration order is non-deterministic.
|
|
|
+ - NIL in data stream decoded as zero value
|
|
|
+ - Never silently skip data when decoding.
|
|
|
+ User decides whether to return an error or silently skip data when keys or indexes
|
|
|
+ in the data stream do not map to fields in the struct.
|
|
|
+ - Detect and error when encoding a cyclic reference (instead of stack overflow shutdown)
|
|
|
+ - Encode/Decode from/to chan types (for iterative streaming support)
|
|
|
+ - Drop-in replacement for encoding/json. `json:` key in struct tag supported.
|
|
|
+ - Provides a RPC Server and Client Codec for net/rpc communication protocol.
|
|
|
+ - Handle unique idiosyncrasies of codecs e.g.
|
|
|
+ - For messagepack, configure how ambiguities in handling raw bytes are resolved
|
|
|
+ - For messagepack, provide rpc server/client codec to support
|
|
|
+ msgpack-rpc protocol defined at:
|
|
|
+ https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md
|
|
|
|
|
|
|
|
|
## Extension Support
|
|
|
@@ -122,12 +122,12 @@ these however you like.
|
|
|
This package maintains symmetry in the encoding and decoding halfs. We
|
|
|
determine how to encode or decode by walking this decision tree
|
|
|
|
|
|
- - is type a codec.Selfer?
|
|
|
- - is there an extension registered for the type?
|
|
|
- - is format binary, and is type a encoding.BinaryMarshaler and BinaryUnmarshaler?
|
|
|
- - is format specifically json, and is type a encoding/json.Marshaler and Unmarshaler?
|
|
|
- - is format text-based, and type an encoding.TextMarshaler and TextUnmarshaler?
|
|
|
- - else we use a pair of functions based on the "kind" of the type e.g. map, slice, int64, etc
|
|
|
+ - is type a codec.Selfer?
|
|
|
+ - is there an extension registered for the type?
|
|
|
+ - is format binary, and is type a encoding.BinaryMarshaler and BinaryUnmarshaler?
|
|
|
+ - is format specifically json, and is type a encoding/json.Marshaler and Unmarshaler?
|
|
|
+ - is format text-based, and type an encoding.TextMarshaler and TextUnmarshaler?
|
|
|
+ - else we use a pair of functions based on the "kind" of the type e.g. map, slice, int64, etc
|
|
|
|
|
|
This symmetry is important to reduce chances of issues happening because the
|
|
|
encoding and decoding sides are out of sync e.g. decoded via very specific
|
|
|
@@ -153,13 +153,13 @@ The Encoder and Decoder are NOT safe for concurrent use.
|
|
|
|
|
|
Consequently, the usage model is basically:
|
|
|
|
|
|
- - Create and initialize the Handle before any use.
|
|
|
- Once created, DO NOT modify it.
|
|
|
- - Multiple Encoders or Decoders can now use the Handle concurrently.
|
|
|
- They only read information off the Handle (never write).
|
|
|
- - However, each Encoder or Decoder MUST not be used concurrently
|
|
|
- - To re-use an Encoder/Decoder, call Reset(...) on it first.
|
|
|
- This allows you use state maintained on the Encoder/Decoder.
|
|
|
+ - Create and initialize the Handle before any use.
|
|
|
+ Once created, DO NOT modify it.
|
|
|
+ - Multiple Encoders or Decoders can now use the Handle concurrently.
|
|
|
+ They only read information off the Handle (never write).
|
|
|
+ - However, each Encoder or Decoder MUST not be used concurrently
|
|
|
+ - To re-use an Encoder/Decoder, call Reset(...) on it first.
|
|
|
+ This allows you use state maintained on the Encoder/Decoder.
|
|
|
|
|
|
Sample usage model:
|
|
|
|
|
|
@@ -243,11 +243,11 @@ Please see http://github.com/ugorji/go-codec-bench .
|
|
|
Struct fields matching the following are ignored during encoding and
|
|
|
decoding
|
|
|
|
|
|
- - struct tag value set to -
|
|
|
- - func, complex numbers, unsafe pointers
|
|
|
- - unexported and not embedded
|
|
|
- - unexported and embedded and not struct kind
|
|
|
- - unexported and embedded pointers (from go1.10)
|
|
|
+ - struct tag value set to -
|
|
|
+ - func, complex numbers, unsafe pointers
|
|
|
+ - unexported and not embedded
|
|
|
+ - unexported and embedded and not struct kind
|
|
|
+ - unexported and embedded pointers (from go1.10)
|
|
|
|
|
|
Every other field in a struct will be encoded/decoded.
|
|
|
|