modulepackage
0.0.0-20221020222930-8b0db17ef1bf
Repository: https://github.com/aarondl/json.git
Documentation: pkg.go.dev
# README
json
Fork of the official JSON package with a single addition of an interface that
allows custom types to decide if they should be omitted or not when omitempty
is in the struct tag.
Implement the following interface to be able to omit a field of a custom type from the output:
type isZeroer interface {
MarshalJSONIsZero() bool
}
Example
package main
import (
"fmt"
"github.com/aarondl/json"
)
type OmitMe struct{}
func (OmitMe) MarshalJSONIsZero() bool { return true }
func (o OmitMe) MarshalJSON() ([]byte, error) {
return []byte(`5`), nil
}
func main() {
a := struct {
NotOmitted OmitMe
Omitted OmitMe `json:",omitempty"`
}{}
b, err := json.MarshalIndent(a, "", " ")
if err != nil {
panic(err)
}
fmt.Printf("%s\n", b)
// {
// "NotOmitted": 5
// }
}
# 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.
An UnsupportedValueError is returned by Marshal when attempting to encode an unsupported value.
# Interfaces
Marshaler is the interface implemented by types that can marshal themselves into valid JSON.
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.
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
.