Code refactoring for bpa operator
[icn.git] / cmd / bpa-operator / vendor / github.com / json-iterator / go / README.md
1 [![Sourcegraph](https://sourcegraph.com/github.com/json-iterator/go/-/badge.svg)](https://sourcegraph.com/github.com/json-iterator/go?badge)
2 [![GoDoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](http://godoc.org/github.com/json-iterator/go)
3 [![Build Status](https://travis-ci.org/json-iterator/go.svg?branch=master)](https://travis-ci.org/json-iterator/go)
4 [![codecov](https://codecov.io/gh/json-iterator/go/branch/master/graph/badge.svg)](https://codecov.io/gh/json-iterator/go)
5 [![rcard](https://goreportcard.com/badge/github.com/json-iterator/go)](https://goreportcard.com/report/github.com/json-iterator/go)
6 [![License](http://img.shields.io/badge/license-mit-blue.svg?style=flat-square)](https://raw.githubusercontent.com/json-iterator/go/master/LICENSE)
7 [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/json-iterator/Lobby)
8
9 A high-performance 100% compatible drop-in replacement of "encoding/json"
10
11 You can also use thrift like JSON using [thrift-iterator](https://github.com/thrift-iterator/go)
12
13 # Benchmark
14
15 ![benchmark](http://jsoniter.com/benchmarks/go-benchmark.png)
16
17 Source code: https://github.com/json-iterator/go-benchmark/blob/master/src/github.com/json-iterator/go-benchmark/benchmark_medium_payload_test.go
18
19 Raw Result (easyjson requires static code generation)
20
21 | | ns/op | allocation bytes | allocation times |
22 | --- | --- | --- | --- |
23 | std decode | 35510 ns/op | 1960 B/op | 99 allocs/op |
24 | easyjson decode | 8499 ns/op | 160 B/op | 4 allocs/op |
25 | jsoniter decode | 5623 ns/op | 160 B/op | 3 allocs/op |
26 | std encode | 2213 ns/op | 712 B/op | 5 allocs/op |
27 | easyjson encode | 883 ns/op | 576 B/op | 3 allocs/op |
28 | jsoniter encode | 837 ns/op | 384 B/op | 4 allocs/op |
29
30 Always benchmark with your own workload. 
31 The result depends heavily on the data input.
32
33 # Usage
34
35 100% compatibility with standard lib
36
37 Replace
38
39 ```go
40 import "encoding/json"
41 json.Marshal(&data)
42 ```
43
44 with 
45
46 ```go
47 import "github.com/json-iterator/go"
48
49 var json = jsoniter.ConfigCompatibleWithStandardLibrary
50 json.Marshal(&data)
51 ```
52
53 Replace
54
55 ```go
56 import "encoding/json"
57 json.Unmarshal(input, &data)
58 ```
59
60 with
61
62 ```go
63 import "github.com/json-iterator/go"
64
65 var json = jsoniter.ConfigCompatibleWithStandardLibrary
66 json.Unmarshal(input, &data)
67 ```
68
69 [More documentation](http://jsoniter.com/migrate-from-go-std.html)
70
71 # How to get
72
73 ```
74 go get github.com/json-iterator/go
75 ```
76
77 # Contribution Welcomed !
78
79 Contributors
80
81 * [thockin](https://github.com/thockin) 
82 * [mattn](https://github.com/mattn)
83 * [cch123](https://github.com/cch123)
84 * [Oleg Shaldybin](https://github.com/olegshaldybin)
85 * [Jason Toffaletti](https://github.com/toffaletti)
86
87 Report issue or pull request, or email taowen@gmail.com, or [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/json-iterator/Lobby)