Categorygithub.com/tokenized/pkgjson
package
0.7.0
Repository: https://github.com/tokenized/pkg.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
15
Dependents
8
Files
3.5k SLOC

# README

Rationale

This json package is a fork of the standard golang encoding/json. The standard package encodes standard binary data as base64. This conflicts with most languages which encode standard binary data as hex. Since JSON messages are often used to communicate with external systems implemented in other languages, this causes issues. In order to improve compatibility between languages this package has been modified to encode standard binary data as hex.

In the file encode.go, in the function encodeByteSlice, the base64 encoding functions have been changed to use encoding/hex.

In the file decode.go, in the function literalStore within the string case, and under the reflect.Slice case, the base64 decoding functions have been changed to use encoding/hex.

Tests also had to be modified to account for these changes.

# Functions

Compact appends to dst the JSON-encoded src with insignificant space characters elided.
HTMLEscape appends to dst the JSON-encoded src with <, >, &, U+2028 and U+2029 characters inside string literals changed to \u003c, \u003e, \u0026, \u2028, \u2029 so that the JSON will be safe to embed inside HTML <script> tags.
Indent appends to dst an indented form of the JSON-encoded src.
Marshal returns the JSON encoding of v.
MarshalIndent is like Marshal but applies Indent to format the output.
NewDecoder returns a new decoder that reads from r.
NewEncoder returns a new encoder that writes to w.
Unmarshal parses the JSON-encoded data and stores the result in the value pointed to by v.
Valid reports whether data is a valid JSON encoding.

# Structs

A Decoder reads and decodes JSON values from an input stream.
An Encoder writes JSON values to an output stream.
An InvalidUnmarshalError describes an invalid argument passed to Unmarshal.
Before Go 1.2, an InvalidUTF8Error was returned by Marshal when attempting to encode a string value with invalid UTF-8 sequences.
A MarshalerError represents an error from calling a MarshalJSON or MarshalText method.
A SyntaxError is a description of a JSON syntax error.
An UnmarshalFieldError describes a JSON object key that led to an unexported (and therefore unwritable) struct field.
An UnmarshalTypeError describes a JSON value that was not appropriate for a value of a specific Go type.
An UnsupportedTypeError is returned by Marshal when attempting to encode an unsupported value type.
No description provided by the author

# Interfaces

Marshaler is the interface implemented by types that can marshal themselves into valid JSON.
A Token holds a value of one of these types: Delim, for the four JSON delimiters [ ] { } bool, for JSON booleans float64, for JSON numbers Number, for JSON numbers string, for JSON string literals nil, for JSON null .
Unmarshaler is the interface implemented by types that can unmarshal a JSON description of themselves.

# Type aliases

A Delim is a JSON array or object delimiter, one of [ ] { or }.
A Number represents a JSON number literal.
RawMessage is a raw encoded JSON value.