Namespace: go.std.encoding.json
v1.0Contents
Summary
Provides a low-level interface to the encoding/json package.
Package json implements encoding and decoding of JSON as defined in
RFC 7159. The mapping between JSON and Go values is described
in the documentation for the Marshal and Unmarshal functions.
See "JSON and Go" for an introduction to this package:
https://golang.org/doc/articles/json_and_go.html
Index
- *Decoder
- *Delim
- *Encoder
- *InvalidUTF8Error
- *InvalidUnmarshalError
- *MarshalerError
- *Number
- *RawMessage
- *SyntaxError
- *UnmarshalFieldError
- *UnmarshalTypeError
- *UnsupportedTypeError
- *UnsupportedValueError
- Compact
- Decoder
- Delim
- Encoder
- HTMLEscape
- Indent
- InvalidUTF8Error
- InvalidUnmarshalError
- Marshal
- MarshalIndent
- Marshaler
- MarshalerError
- NewDecoder
- NewEncoder
- Number
- RawMessage
- SyntaxError
- Token
- Unmarshal
- UnmarshalFieldError
- UnmarshalTypeError
- Unmarshaler
- UnsupportedTypeError
- UnsupportedValueError
- Valid
- arrayOfDecoder
- arrayOfDelim
- arrayOfEncoder
- arrayOfInvalidUTF8Error
- arrayOfInvalidUnmarshalError
- arrayOfMarshaler
- arrayOfMarshalerError
- arrayOfNumber
- arrayOfRawMessage
- arrayOfSyntaxError
- arrayOfToken
- arrayOfUnmarshalFieldError
- arrayOfUnmarshalTypeError
- arrayOfUnmarshaler
- arrayOfUnsupportedTypeError
- arrayOfUnsupportedValueError
Legend
-
Constant
Variable
Function
Macro
Special form
Type
GoVar
Receiver/Method
Constants
Constants are variables with :const true in their metadata. Joker currently does not recognize them as special; as such, it allows redefining them or their values.-
(None.)
Variables
-
(None.)
Functions, Macros, and Special Forms
-
Compact
Function v1.0(Compact dst src)
Compact appends to dst the JSON-encoded src with
insignificant space characters elided.
Go input arguments: (dst *bytes.Buffer, src []byte)
Go returns: error
Joker input arguments: [^go.std.bytes/*Buffer dst, ^arrayOfByte src]
Joker returns: ^Error -
HTMLEscape
Function v1.0(HTMLEscape dst src)
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.
For historical reasons, web browsers don't honor standard HTML
escaping within <script> tags, so an alternative JSON encoding must
be used.
Go input arguments: (dst *bytes.Buffer, src []byte)
Joker input arguments: [^go.std.bytes/*Buffer dst, ^arrayOfByte src] -
Indent
Function v1.0(Indent dst src prefix indent)
Indent appends to dst an indented form of the JSON-encoded src.
Each element in a JSON object or array begins on a new,
indented line beginning with prefix followed by one or more
copies of indent according to the indentation nesting.
The data appended to dst does not begin with the prefix nor
any indentation, to make it easier to embed inside other formatted JSON data.
Although leading space characters (space, tab, carriage return, newline)
at the beginning of src are dropped, trailing space characters
at the end of src are preserved and copied to dst.
For example, if src has no trailing spaces, neither will dst;
if src ends in a trailing newline, so will dst.
Go input arguments: (dst *bytes.Buffer, src []byte, prefix string, indent string)
Go returns: error
Joker input arguments: [^go.std.bytes/*Buffer dst, ^arrayOfByte src, ^String prefix, ^String indent]
Joker returns: ^Error -
Marshal
Function v1.0(Marshal v)
Marshal returns the JSON encoding of v.
Marshal traverses the value v recursively.
If an encountered value implements the Marshaler interface
and is not a nil pointer, Marshal calls its MarshalJSON method
to produce JSON. If no MarshalJSON method is present but the
value implements encoding.TextMarshaler instead, Marshal calls
its MarshalText method and encodes the result as a JSON string.
The nil pointer exception is not strictly necessary
but mimics a similar, necessary exception in the behavior of
UnmarshalJSON.
Otherwise, Marshal uses the following type-dependent default encodings:
Boolean values encode as JSON booleans.
Floating point, integer, and Number values encode as JSON numbers.
String values encode as JSON strings coerced to valid UTF-8,
replacing invalid bytes with the Unicode replacement rune.
So that the JSON will be safe to embed inside HTML <script> tags,
the string is encoded using HTMLEscape,
which replaces "<", ">", "&", U+2028, and U+2029 are escaped
to "\u003c","\u003e", "\u0026", "\u2028", and "\u2029".
This replacement can be disabled when using an Encoder,
by calling SetEscapeHTML(false).
Array and slice values encode as JSON arrays, except that
[]byte encodes as a base64-encoded string, and a nil slice
encodes as the null JSON value.
Struct values encode as JSON objects.
Each exported struct field becomes a member of the object, using the
field name as the object key, unless the field is omitted for one of the
reasons given below.
The encoding of each struct field can be customized by the format string
stored under the "json" key in the struct field's tag.
The format string gives the name of the field, possibly followed by a
comma-separated list of options. The name may be empty in order to
specify options without overriding the default field name.
The "omitempty" option specifies that the field should be omitted
from the encoding if the field has an empty value, defined as
false, 0, a nil pointer, a nil interface value, and any empty array,
slice, map, or string.
As a special case, if the field tag is "-", the field is always omitted.
Note that a field with name "-" can still be generated using the tag "-,".
Examples of struct field tags and their meanings:
// Field appears in JSON as key "myName".
Field int `json:"myName"`
// Field appears in JSON as key "myName" and
// the field is omitted from the object if its value is empty,
// as defined above.
Field int `json:"myName,omitempty"`
// Field appears in JSON as key "Field" (the default), but
// the field is skipped if empty.
// Note the leading comma.
Field int `json:",omitempty"`
// Field is ignored by this package.
Field int `json:"-"`
// Field appears in JSON as key "-".
Field int `json:"-,"`
The "string" option signals that a field is stored as JSON inside a
JSON-encoded string. It applies only to fields of string, floating point,
integer, or boolean types. This extra level of encoding is sometimes used
when communicating with JavaScript programs:
Int64String int64 `json:",string"`
The key name will be used if it's a non-empty string consisting of
only Unicode letters, digits, and ASCII punctuation except quotation
marks, backslash, and comma.
Anonymous struct fields are usually marshaled as if their inner exported fields
were fields in the outer struct, subject to the usual Go visibility rules amended
as described in the next paragraph.
An anonymous struct field with a name given in its JSON tag is treated as
having that name, rather than being anonymous.
An anonymous struct field of interface type is treated the same as having
that type as its name, rather than being anonymous.
The Go visibility rules for struct fields are amended for JSON when
deciding which field to marshal or unmarshal. If there are
multiple fields at the same level, and that level is the least
nested (and would therefore be the nesting level selected by the
usual Go rules), the following extra rules apply:
1) Of those fields, if any are JSON-tagged, only tagged fields are considered,
even if there are multiple untagged fields that would otherwise conflict.
2) If there is exactly one field (tagged or not according to the first rule), that is selected.
3) Otherwise there are multiple fields, and all are ignored; no error occurs.
Handling of anonymous struct fields is new in Go 1.1.
Prior to Go 1.1, anonymous struct fields were ignored. To force ignoring of
an anonymous struct field in both current and earlier versions, give the field
a JSON tag of "-".
Map values encode as JSON objects. The map's key type must either be a
string, an integer type, or implement encoding.TextMarshaler. The map keys
are sorted and used as JSON object keys by applying the following rules,
subject to the UTF-8 coercion described for string values above:
- keys of any string type are used directly
- encoding.TextMarshalers are marshaled
- integer keys are converted to strings
Pointer values encode as the value pointed to.
A nil pointer encodes as the null JSON value.
Interface values encode as the value contained in the interface.
A nil interface value encodes as the null JSON value.
Channel, complex, and function values cannot be encoded in JSON.
Attempting to encode such a value causes Marshal to return
an UnsupportedTypeError.
JSON cannot represent cyclic data structures and Marshal does not
handle them. Passing cyclic structures to Marshal will result in
an error.
Go input arguments: (v any)
Go returns: ([]byte, error)
Joker input arguments: [^GoObject v]
Joker returns: [^arrayOfByte, ^Error] -
MarshalIndent
Function v1.0(MarshalIndent v prefix indent)
MarshalIndent is like Marshal but applies Indent to format the output.
Each JSON element in the output will begin on a new line beginning with prefix
followed by one or more copies of indent according to the indentation nesting.
Go input arguments: (v any, prefix string, indent string)
Go returns: ([]byte, error)
Joker input arguments: [^GoObject v, ^String prefix, ^String indent]
Joker returns: [^arrayOfByte, ^Error] -
NewDecoder
Function v1.0(NewDecoder r)
NewDecoder returns a new decoder that reads from r.
The decoder introduces its own buffering and may
read data from r beyond the JSON values requested.
Go input arguments: (r io.Reader)
Go returns: *Decoder
Joker input arguments: [^go.std.io/Reader r]
Joker returns: ^*Decoder -
NewEncoder
Function v1.0(NewEncoder w)
NewEncoder returns a new encoder that writes to w.
Go input arguments: (w io.Writer)
Go returns: *Encoder
Joker input arguments: [^go.std.io/Writer w]
Joker returns: ^*Encoder -
Unmarshal
Function v1.0(Unmarshal data v)
Unmarshal parses the JSON-encoded data and stores the result
in the value pointed to by v. If v is nil or not a pointer,
Unmarshal returns an InvalidUnmarshalError.
Unmarshal uses the inverse of the encodings that
Marshal uses, allocating maps, slices, and pointers as necessary,
with the following additional rules:
To unmarshal JSON into a pointer, Unmarshal first handles the case of
the JSON being the JSON literal null. In that case, Unmarshal sets
the pointer to nil. Otherwise, Unmarshal unmarshals the JSON into
the value pointed at by the pointer. If the pointer is nil, Unmarshal
allocates a new value for it to point to.
To unmarshal JSON into a value implementing the Unmarshaler interface,
Unmarshal calls that value's UnmarshalJSON method, including
when the input is a JSON null.
Otherwise, if the value implements encoding.TextUnmarshaler
and the input is a JSON quoted string, Unmarshal calls that value's
UnmarshalText method with the unquoted form of the string.
To unmarshal JSON into a struct, Unmarshal matches incoming object
keys to the keys used by Marshal (either the struct field name or its tag),
preferring an exact match but also accepting a case-insensitive match. By
default, object keys which don't have a corresponding struct field are
ignored (see Decoder.DisallowUnknownFields for an alternative).
To unmarshal JSON into an interface value,
Unmarshal stores one of these in the interface value:
bool, for JSON booleans
float64, for JSON numbers
string, for JSON strings
[]interface{}, for JSON arrays
map[string]interface{}, for JSON objects
nil for JSON null
To unmarshal a JSON array into a slice, Unmarshal resets the slice length
to zero and then appends each element to the slice.
As a special case, to unmarshal an empty JSON array into a slice,
Unmarshal replaces the slice with a new empty slice.
To unmarshal a JSON array into a Go array, Unmarshal decodes
JSON array elements into corresponding Go array elements.
If the Go array is smaller than the JSON array,
the additional JSON array elements are discarded.
If the JSON array is smaller than the Go array,
the additional Go array elements are set to zero values.
To unmarshal a JSON object into a map, Unmarshal first establishes a map to
use. If the map is nil, Unmarshal allocates a new map. Otherwise Unmarshal
reuses the existing map, keeping existing entries. Unmarshal then stores
key-value pairs from the JSON object into the map. The map's key type must
either be any string type, an integer, implement json.Unmarshaler, or
implement encoding.TextUnmarshaler.
If a JSON value is not appropriate for a given target type,
or if a JSON number overflows the target type, Unmarshal
skips that field and completes the unmarshaling as best it can.
If no more serious errors are encountered, Unmarshal returns
an UnmarshalTypeError describing the earliest such error. In any
case, it's not guaranteed that all the remaining fields following
the problematic one will be unmarshaled into the target object.
The JSON null value unmarshals into an interface, map, pointer, or slice
by setting that Go value to nil. Because null is often used in JSON to mean
``not present,'' unmarshaling a JSON null into any other Go type has no effect
on the value and produces no error.
When unmarshaling quoted strings, invalid UTF-8 or
invalid UTF-16 surrogate pairs are not treated as an error.
Instead, they are replaced by the Unicode replacement
character U+FFFD.
Go input arguments: (data []byte, v any)
Go returns: error
Joker input arguments: [^arrayOfByte data, ^GoObject v]
Joker returns: ^Error -
Valid
Function v1.0(Valid data)
Valid reports whether data is a valid JSON encoding.
Go input arguments: (data []byte)
Go returns: bool
Joker input arguments: [^arrayOfByte data]
Joker returns: ^Boolean
Types
-
*Decoder
Concrete Type v1.0A Decoder reads and decodes JSON values from an input stream.
-
Buffered
Receiver for *Decoder v1.0([])
Buffered returns a reader of the data remaining in the Decoder's
buffer. The reader is valid until the next call to Decode.
-
Decode
Receiver for *Decoder v1.0([v])
Decode reads the next JSON-encoded value from its
input and stores it in the value pointed to by v.
See the documentation for Unmarshal for details about
the conversion of JSON into a Go value.
-
DisallowUnknownFields
Receiver for *Decoder v1.0([])
DisallowUnknownFields causes the Decoder to return an error when the destination
is a struct and the input contains object keys which do not match any
non-ignored, exported fields in the destination.
-
InputOffset
Receiver for *Decoder v1.0([])
InputOffset returns the input stream byte offset of the current decoder position.
The offset gives the location of the end of the most recently returned token
and the beginning of the next token.
-
More
Receiver for *Decoder v1.0([])
More reports whether there is another element in the
current array or object being parsed.
-
Token
Receiver for *Decoder v1.0([])
Token returns the next JSON token in the input stream.
At the end of the input stream, Token returns nil, io.EOF.
Token guarantees that the delimiters [ ] { } it returns are
properly nested and matched: if Token encounters an unexpected
delimiter in the input, it will return an error.
The input stream consists of basic JSON values—bool, string,
number, and null—along with delimiters [ ] { } of type Delim
to mark the start and end of arrays and objects.
Commas and colons are elided.
-
UseNumber
Receiver for *Decoder v1.0([])
UseNumber causes the Decoder to unmarshal a number into an interface{} as a
Number instead of as a float64.
-
*Delim
Concrete Type v1.0A Delim is a JSON array or object delimiter, one of [ ] { or }.
-
*Encoder
Concrete Type v1.0An Encoder writes JSON values to an output stream.
-
Encode
Receiver for *Encoder v1.0([v])
Encode writes the JSON encoding of v to the stream,
followed by a newline character.
See the documentation for Marshal for details about the
conversion of Go values to JSON.
-
SetEscapeHTML
Receiver for *Encoder v1.0([on])
SetEscapeHTML specifies whether problematic HTML characters
should be escaped inside JSON quoted strings.
The default behavior is to escape &, <, and > to \u0026, \u003c, and \u003e
to avoid certain safety problems that can arise when embedding JSON in HTML.
In non-HTML settings where the escaping interferes with the readability
of the output, SetEscapeHTML(false) disables this behavior.
-
SetIndent
Receiver for *Encoder v1.0([prefix indent])
SetIndent instructs the encoder to format each subsequent encoded
value as if indented by the package-level function Indent(dst, src, prefix, indent).
Calling SetIndent("", "") disables indentation.
-
*InvalidUTF8Error
Concrete Type v1.0Before Go 1.2, an InvalidUTF8Error was returned by Marshal when
attempting to encode a string value with invalid UTF-8 sequences.
As of Go 1.2, Marshal instead coerces the string to valid UTF-8 by
replacing invalid bytes with the Unicode replacement rune U+FFFD.
Deprecated: No longer used; kept for compatibility.
-
Error
Receiver for *InvalidUTF8Error v1.0([])
-
*InvalidUnmarshalError
Concrete Type v1.0An InvalidUnmarshalError describes an invalid argument passed to Unmarshal.
(The argument to Unmarshal must be a non-nil pointer.)
-
Error
Receiver for *InvalidUnmarshalError v1.0([])
-
*MarshalerError
Concrete Type v1.0A MarshalerError represents an error from calling a MarshalJSON or MarshalText method.
-
Error
Receiver for *MarshalerError v1.0([])
-
Unwrap
Receiver for *MarshalerError v1.0([])
Unwrap returns the underlying error.
-
*Number
Concrete Type v1.0A Number represents a JSON number literal.
-
*RawMessage
Concrete Type v1.0RawMessage is a raw encoded JSON value.
It implements Marshaler and Unmarshaler and can
be used to delay JSON decoding or precompute a JSON encoding.
-
UnmarshalJSON
Receiver for *RawMessage v1.0([data])
UnmarshalJSON sets *m to a copy of data.
-
*SyntaxError
Concrete Type v1.0A SyntaxError is a description of a JSON syntax error.
-
Error
Receiver for *SyntaxError v1.0([])
-
*UnmarshalFieldError
Concrete Type v1.0An UnmarshalFieldError describes a JSON object key that
led to an unexported (and therefore unwritable) struct field.
Deprecated: No longer used; kept for compatibility.
-
Error
Receiver for *UnmarshalFieldError v1.0([])
-
*UnmarshalTypeError
Concrete Type v1.0An UnmarshalTypeError describes a JSON value that was
not appropriate for a value of a specific Go type.
-
Error
Receiver for *UnmarshalTypeError v1.0([])
-
*UnsupportedTypeError
Concrete Type v1.0An UnsupportedTypeError is returned by Marshal when attempting
to encode an unsupported value type.
-
Error
Receiver for *UnsupportedTypeError v1.0([])
-
*UnsupportedValueError
Concrete Type v1.0An UnsupportedValueError is returned by Marshal when attempting
to encode an unsupported value.
-
Error
Receiver for *UnsupportedValueError v1.0([])
-
Decoder
Concrete Type v1.0A Decoder reads and decodes JSON values from an input stream.
-
Delim
Concrete Type v1.0A Delim is a JSON array or object delimiter, one of [ ] { or }.
-
String
Receiver for Delim v1.0([])
-
Encoder
Concrete Type v1.0An Encoder writes JSON values to an output stream.
-
InvalidUTF8Error
Concrete Type v1.0Before Go 1.2, an InvalidUTF8Error was returned by Marshal when
attempting to encode a string value with invalid UTF-8 sequences.
As of Go 1.2, Marshal instead coerces the string to valid UTF-8 by
replacing invalid bytes with the Unicode replacement rune U+FFFD.
Deprecated: No longer used; kept for compatibility.
-
InvalidUnmarshalError
Concrete Type v1.0An InvalidUnmarshalError describes an invalid argument passed to Unmarshal.
(The argument to Unmarshal must be a non-nil pointer.)
-
Marshaler
Abstract Type v1.0Marshaler is the interface implemented by types that
can marshal themselves into valid JSON.
-
MarshalJSON
Method for Marshaler v1.0([])
-
MarshalerError
Concrete Type v1.0A MarshalerError represents an error from calling a MarshalJSON or MarshalText method.
-
Number
Concrete Type v1.0A Number represents a JSON number literal.
-
Float64
Receiver for Number v1.0([])
Float64 returns the number as a float64.
-
Int64
Receiver for Number v1.0([])
Int64 returns the number as an int64.
-
String
Receiver for Number v1.0([])
String returns the literal text of the number.
-
RawMessage
Concrete Type v1.0RawMessage is a raw encoded JSON value.
It implements Marshaler and Unmarshaler and can
be used to delay JSON decoding or precompute a JSON encoding.
-
MarshalJSON
Receiver for RawMessage v1.0([])
MarshalJSON returns m as the JSON encoding of m.
-
SyntaxError
Concrete Type v1.0A SyntaxError is a description of a JSON syntax error.
-
Token
Abstract Type v1.0A 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
-
UnmarshalFieldError
Concrete Type v1.0An UnmarshalFieldError describes a JSON object key that
led to an unexported (and therefore unwritable) struct field.
Deprecated: No longer used; kept for compatibility.
-
UnmarshalTypeError
Concrete Type v1.0An UnmarshalTypeError describes a JSON value that was
not appropriate for a value of a specific Go type.
-
Unmarshaler
Abstract Type v1.0Unmarshaler is the interface implemented by types
that can unmarshal a JSON description of themselves.
The input can be assumed to be a valid encoding of
a JSON value. UnmarshalJSON must copy the JSON data
if it wishes to retain the data after returning.
By convention, to approximate the behavior of Unmarshal itself,
Unmarshalers implement UnmarshalJSON([]byte("null")) as a no-op.
-
UnmarshalJSON
Method for Unmarshaler v1.0([arg1])
-
UnsupportedTypeError
Concrete Type v1.0An UnsupportedTypeError is returned by Marshal when attempting
to encode an unsupported value type.
-
UnsupportedValueError
Concrete Type v1.0An UnsupportedValueError is returned by Marshal when attempting
to encode an unsupported value.
-
arrayOfDecoder
Concrete Type v1.0A Decoder reads and decodes JSON values from an input stream.
-
arrayOfDelim
Concrete Type v1.0A Delim is a JSON array or object delimiter, one of [ ] { or }.
-
arrayOfEncoder
Concrete Type v1.0An Encoder writes JSON values to an output stream.
-
arrayOfInvalidUTF8Error
Concrete Type v1.0Before Go 1.2, an InvalidUTF8Error was returned by Marshal when
attempting to encode a string value with invalid UTF-8 sequences.
As of Go 1.2, Marshal instead coerces the string to valid UTF-8 by
replacing invalid bytes with the Unicode replacement rune U+FFFD.
Deprecated: No longer used; kept for compatibility.
-
arrayOfInvalidUnmarshalError
Concrete Type v1.0An InvalidUnmarshalError describes an invalid argument passed to Unmarshal.
(The argument to Unmarshal must be a non-nil pointer.)
-
arrayOfMarshaler
Concrete Type v1.0Marshaler is the interface implemented by types that
can marshal themselves into valid JSON.
-
arrayOfMarshalerError
Concrete Type v1.0A MarshalerError represents an error from calling a MarshalJSON or MarshalText method.
-
arrayOfNumber
Concrete Type v1.0A Number represents a JSON number literal.
-
arrayOfRawMessage
Concrete Type v1.0RawMessage is a raw encoded JSON value.
It implements Marshaler and Unmarshaler and can
be used to delay JSON decoding or precompute a JSON encoding.
-
arrayOfSyntaxError
Concrete Type v1.0A SyntaxError is a description of a JSON syntax error.
-
arrayOfToken
Concrete Type v1.0A 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
-
arrayOfUnmarshalFieldError
Concrete Type v1.0An UnmarshalFieldError describes a JSON object key that
led to an unexported (and therefore unwritable) struct field.
Deprecated: No longer used; kept for compatibility.
-
arrayOfUnmarshalTypeError
Concrete Type v1.0An UnmarshalTypeError describes a JSON value that was
not appropriate for a value of a specific Go type.
-
arrayOfUnmarshaler
Concrete Type v1.0Unmarshaler is the interface implemented by types
that can unmarshal a JSON description of themselves.
The input can be assumed to be a valid encoding of
a JSON value. UnmarshalJSON must copy the JSON data
if it wishes to retain the data after returning.
By convention, to approximate the behavior of Unmarshal itself,
Unmarshalers implement UnmarshalJSON([]byte("null")) as a no-op.
-
arrayOfUnsupportedTypeError
Concrete Type v1.0An UnsupportedTypeError is returned by Marshal when attempting
to encode an unsupported value type.
-
arrayOfUnsupportedValueError
Concrete Type v1.0An UnsupportedValueError is returned by Marshal when attempting
to encode an unsupported value.