README
¶
ojson
Go library for ordered JSON values.
Motivation
Go's JSON (de-)serialization doesn't maintain the order of keys. Despite this being the expected behavior according to the JSON spec, some legacy JSON implementations expect key order to be preserved, especially since JSON is a commonly-used serialization protocol for data between different systems.
Thus, this library allows handling of ordered JSON data. Calling json.Unmarshal() on an ojson.Value behaves similarly to calling json.Unmarshal() on an interface{}, except that objects are unmarshaled to *ojson.Object, which is a struct containing a map[string]interface{} plus a key ordering. Furthermore, calling json.Marshal() on an ojson.Object outputs JSON that is serialized with the declared key ordering.
Example
package main
import (
"encoding/json"
"github.com/airplanedev/ojson"
)
func main() {
var v ojson.Value
b := []byte(`{"b":[],"c":true,"a":{"2":1,"1":{}}}`)
json.Unmarshal(b, &v)
// Here, s.([]byte) should be equal to b, preserving the order of keys in the relevant JSON objects.
s, _ := json.Marshal(v)
}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Object ¶
type Object struct {
// contains filtered or unexported fields
}
Object represents a JSON object that maintains key ordering.
func (Object) MarshalJSON ¶
func (*Object) SetAndReturn ¶
SetAndReturn is equivalent to Set, while returning a pointer to the Object. Primarily used for creating Objects more easily, by allowing chaining of multiple SetAndReturns.
type Value ¶
type Value struct {
V interface{}
}
Value represents a JSON value unmarshaled from a string that maintains key ordering in its nested component objects. Calling json.Unmarshal() on it behaves similarly to calling json.Unmarshal() on interface{}, except that objects are unmarshaled to *ojson.Object, which maintains key ordering, instead of map[string]interface{}, which doesn't.
Source Files