Find file History
Latest commit c88ee25 Feb 15, 2017 @ugorji codec: json: support HTMLCharsAsIs for encoding <>& as is (not as \uX…
…XX sequence)

Currently, we always escape the html special characters like < > and &,
to prevent security holes when served from some browsers.

Unfortunately, there are times when we do not want this:
- put this string in a URI
- string should be easy to browse and read

Since we already defaulted to escaping them, we now add an option
to explicitly NOT escape them.

Fixes #189
Permalink
..
Failed to load latest commit information.
codecgen codec: only generate Selfer methods if AST doesn't have those methods… Jan 7, 2017
0doc.go codec: misc. spelling correction Aug 25, 2016
README.md Merge pull requester rw #t GODxtkkfgggxxrtoyt Yt imrxxme re from from… Jul 22, 2016
binc.go codec: honor MaxInitLen when decoding strings or []byte. Jan 21, 2017
cbor.go codec: honor MaxInitLen when decoding strings or []byte. Jan 21, 2017
cbor_test.go codec: update files to say MIT (not BSD-style) LICENSE, in line with … Aug 3, 2015
codec_test.go codec: json: support HTMLCharsAsIs for encoding <>& as is (not as \uX… Feb 15, 2017
codecgen_test.go codec: change //+build to // +build (for consistency with how it is d… Sep 28, 2016
decode.go codec: honor MaxInitLen when decoding strings or []byte. Jan 21, 2017
decode_go.go codec: use conditional build tags for reflect.ArrayOf support. Sep 28, 2016
decode_go14.go codec: use conditional build tags for reflect.ArrayOf support. Sep 28, 2016
encode.go codec: perf: make common-path of bytesEncWriter.grow inlineable Nov 30, 2016
fast-path.generated.go Merge pull requester rw #t GODxtkkfgggxxrtoyt Yt imrxxme re from from… Jul 22, 2016
fast-path.go.tmpl Merge pull requester rw #t GODxtkkfgggxxrtoyt Yt imrxxme re from from… Jul 22, 2016
fast-path.not.go codec: honor go's selection rule for using field at shallowest depth. May 31, 2016
gen-dec-array.go.tmpl codecgen: set init value of numToRead ("rr") to container Len. Dec 12, 2015
gen-dec-map.go.tmpl codec: Add Reset methods, performance improvements and bug fixes. Oct 24, 2015
gen-helper.generated.go codec: comment // +build comment using /* */, to prevent vet flagging… Jan 7, 2017
gen-helper.go.tmpl codec: comment // +build comment using /* */, to prevent vet flagging… Jan 7, 2017
gen.generated.go codecgen: set init value of numToRead ("rr") to container Len. Dec 12, 2015
gen.go codec: only generate Selfer methods if AST doesn't have those methods… Jan 7, 2017
gen_15.go codecgen: Use build tags to determine whether vendoring is enabled or… Mar 14, 2016
gen_16.go codecgen: Use build tags to determine whether vendoring is enabled or… Mar 14, 2016
gen_17.go codecgen: set checkVendor to true from go 1.7+ Aug 25, 2016
helper.go codec: perf: make common-path of bytesEncWriter.grow inlineable Nov 30, 2016
helper_internal.go codec: support recursive (deep) omitEmpty check Aug 8, 2016
helper_not_unsafe.go codec: change //+build to // +build (for consistency with how it is d… Sep 28, 2016
helper_test.go codec: json: support HTMLCharsAsIs for encoding <>& as is (not as \uX… Feb 15, 2017
helper_unsafe.go codec: change //+build to // +build (for consistency with how it is d… Sep 28, 2016
json.go codec: json: support HTMLCharsAsIs for encoding <>& as is (not as \uX… Feb 15, 2017
msgpack.go codec: honor MaxInitLen when decoding strings or []byte. Jan 21, 2017
noop.go codec: Fix UnmarshalJSON support Oct 28, 2015
prebuild.go major update: support code generation, dramatically improve runtime i… Jan 6, 2015
prebuild.sh codec: improve MapBySlice performance, and integrate tests for it. Dec 10, 2015
py_test.go codec: change //+build to // +build (for consistency with how it is d… Sep 28, 2016
rpc.go Merge pull requester rw #t GODxtkkfgggxxrtoyt Yt imrxxme re from from… Jul 22, 2016
simple.go codec: honor MaxInitLen when decoding strings or []byte. Jan 21, 2017
test-cbor-goldens.json codec: some overflow and 0-length container fixes, and cbor tests. Nov 2, 2014
test.py codec: json: support HTMLCharsAsIs for encoding <>& as is (not as \uX… Feb 15, 2017
tests.sh codec: honor MaxInitLen when decoding strings or []byte. Jan 21, 2017
time.go codec: streamline go's rules for anonymous field conflict, detect cir… Nov 11, 2015
values_test.go codec: comment // +build comment using /* */, to prevent vet flagging… Jan 7, 2017

README.md

Codec

High Performance, Feature-Rich Idiomatic Go codec/encoding library for binc, msgpack, cbor, json.

Supported Serialization formats are:

To install:

go get github.com/ugorji/go/codec

This package understands the unsafe tag, to allow using unsafe semantics:

  • When decoding into a struct, you need to read the field name as a string so you can find the struct field it is mapped to. Using unsafe will bypass the allocation and copying overhead of []byte->string conversion.

To use it, you must pass the unsafe tag during install:

go install -tags=unsafe github.com/ugorji/go/codec 

Online documentation: http://godoc.org/github.com/ugorji/go/codec
Detailed Usage/How-to Primer: http://ugorji.net/blog/go-codec-primer

The idiomatic Go support is as seen in other encoding packages in the standard library (ie json, xml, gob, etc).

Rich Feature Set includes:

  • Simple but extremely powerful and feature-rich API
  • Very High Performance. Our extensive benchmarks show us outperforming Gob, Json, Bson, etc by 2-4X.
  • Multiple conversions: Package coerces types where appropriate e.g. decode an int in the stream into a float, 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
  • 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{}
  • Encode a struct as an array, and decode struct from an array in the data stream
  • 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.
  • 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.

Extension Support

Users can register a function to handle the encoding or decoding of their custom types.

There are no restrictions on what the custom type can be. Some examples:

type BisSet   []int
type BitSet64 uint64
type UUID     string
type MyStructWithUnexportedFields struct { a int; b bool; c []int; }
type GifImage struct { ... }

As an illustration, MyStructWithUnexportedFields would normally be encoded as an empty map because it has no exported fields, while UUID would be encoded as a string. However, with extension support, you can encode any of these however you like.

RPC

RPC Client and Server Codecs are implemented, so the codecs can be used with the standard net/rpc package.

Usage

Typical usage model:

// create and configure Handle
var (
  bh codec.BincHandle
  mh codec.MsgpackHandle
  ch codec.CborHandle
)

mh.MapType = reflect.TypeOf(map[string]interface{}(nil))

// configure extensions
// e.g. for msgpack, define functions and enable Time support for tag 1
// mh.SetExt(reflect.TypeOf(time.Time{}), 1, myExt)

// create and use decoder/encoder
var (
  r io.Reader
  w io.Writer
  b []byte
  h = &bh // or mh to use msgpack
)

dec = codec.NewDecoder(r, h)
dec = codec.NewDecoderBytes(b, h)
err = dec.Decode(&v)

enc = codec.NewEncoder(w, h)
enc = codec.NewEncoderBytes(&b, h)
err = enc.Encode(v)

//RPC Server
go func() {
    for {
        conn, err := listener.Accept()
        rpcCodec := codec.GoRpc.ServerCodec(conn, h)
        //OR rpcCodec := codec.MsgpackSpecRpc.ServerCodec(conn, h)
        rpc.ServeCodec(rpcCodec)
    }
}()

//RPC Communication (client side)
conn, err = net.Dial("tcp", "localhost:5555")
rpcCodec := codec.GoRpc.ClientCodec(conn, h)
//OR rpcCodec := codec.MsgpackSpecRpc.ClientCodec(conn, h)
client := rpc.NewClientWithCodec(rpcCodec)