Package json
import "json"
Package files
decode.go encode.go indent.go scanner.go stream.gofunc Compact
func Compact(dst *bytes.Buffer, src []byte) os.Error
Compact appends to dst the JSON-encoded src with insignificant space characters elided.
func HTMLEscape
func HTMLEscape(dst *bytes.Buffer, src []byte)
HTMLEscape appends to dst the JSON-encoded src with <, >, and & characters inside string literals changed to \u003c, \u003e, \u0026 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.
func Indent
func Indent(dst *bytes.Buffer, src []byte, prefix, indent string) os.Error
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 has no trailing newline, to make it easier to embed inside other formatted JSON data.
func Marshal
func Marshal(v interface{}) ([]byte, os.Error)
Marshal returns the JSON encoding of v.
Marshal traverses the value v recursively. If an encountered value implements the Marshaler interface, Marshal calls its MarshalJSON method to produce JSON.
Otherwise, Marshal uses the following type-dependent default encodings:
Boolean values encode as JSON booleans.
Floating point and integer values encode as JSON numbers.
String values encode as JSON strings, with each invalid UTF-8 sequence replaced by the encoding of the Unicode replacement character U+FFFD.
Array and slice values encode as JSON arrays.
Struct values encode as JSON objects. Each struct field becomes a member of the object. By default the object's key name is the struct field name converted to lower case. If the struct field has a tag, that tag will be used as the name instead.
Map values encode as JSON objects. The map's key type must be string; the object keys are used directly as map keys.
Pointer values encode as the value pointed to. A nil pointer encodes as the null JSON object.
Interface values encode as the value contained in the interface. A nil interface value encodes as the null JSON object.
Channel, complex, and function values cannot be encoded in JSON. Attempting to encode such a value causes Marshal to return an InvalidTypeError.
JSON cannot represent cyclic data structures and Marshal does not handle them. Passing cyclic structures to Marshal will result in an infinite recursion.
func MarshalForHTML
func MarshalForHTML(v interface{}) ([]byte, os.Error)
MarshalForHTML is like Marshal but applies HTMLEscape to the output.
func MarshalIndent
func MarshalIndent(v interface{}, prefix, indent string) ([]byte, os.Error)
MarshalIndent is like Marshal but applies Indent to format the output.
func Unmarshal
func Unmarshal(data []byte, v interface{}) os.Error
Unmarshal parses the JSON-encoded data and stores the result in the value pointed to by v.
Unmarshal traverses the value v recursively. If an encountered value implements the Unmarshaler interface, Unmarshal calls its UnmarshalJSON method with a well-formed JSON encoding.
Otherwise, Unmarshal uses the inverse of the encodings that Marshal uses, allocating maps, slices, and pointers as necessary, with the following additional rules:
To unmarshal a JSON value into a nil interface value, the type stored in the interface value is one of:
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
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 unmarshalling as best it can. If no more serious errors are encountered, Unmarshal returns an UnmarshalTypeError describing the earliest such error.
type Decoder
A Decoder reads and decodes JSON objects from an input stream.
type Decoder struct {
// contains unexported fields
}
func NewDecoder
func NewDecoder(r io.Reader) *Decoder
NewDecoder returns a new decoder that reads from r.
func (*Decoder) Decode
func (dec *Decoder) Decode(v interface{}) os.Error
Decode reads the next JSON-encoded value from the connection 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.
type Encoder
An Encoder writes JSON objects to an output stream.
type Encoder struct {
// contains unexported fields
}
func NewEncoder
func NewEncoder(w io.Writer) *Encoder
NewEncoder returns a new encoder that writes to w.
func (*Encoder) Encode
func (enc *Encoder) Encode(v interface{}) os.Error
Encode writes the JSON encoding of v to the connection.
See the documentation for Marshal for details about the conversion of Go values to JSON.
type InvalidUnmarshalError
An InvalidUnmarshalError describes an invalid argument passed to Unmarshal. (The argument to Unmarshal must be a non-nil pointer.)
type InvalidUnmarshalError struct {
Type reflect.Type
}
func (*InvalidUnmarshalError) String
func (e *InvalidUnmarshalError) String() string
type Marshaler
Marshaler is the interface implemented by objects that can marshal themselves into valid JSON.
type Marshaler interface {
MarshalJSON() ([]byte, os.Error)
}
type MarshalerError
type MarshalerError struct {
Type reflect.Type
Error os.Error
}
func (*MarshalerError) String
func (e *MarshalerError) String() string
type RawMessage
RawMessage is a raw encoded JSON object. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.
type RawMessage []byte
func (*RawMessage) MarshalJSON
func (m *RawMessage) MarshalJSON() ([]byte, os.Error)
MarshalJSON returns *m as the JSON encoding of m.
func (*RawMessage) UnmarshalJSON
func (m *RawMessage) UnmarshalJSON(data []byte) os.Error
UnmarshalJSON sets *m to a copy of data.
type SyntaxError
A SyntaxError is a description of a JSON syntax error.
type SyntaxError string
func (SyntaxError) String
func (e SyntaxError) String() string
type UnmarshalTypeError
An UnmarshalTypeError describes a JSON value that was not appropriate for a value of a specific Go type.
type UnmarshalTypeError struct {
Value string // description of JSON value - "bool", "array", "number -5"
Type reflect.Type // type of Go value it could not be assigned to
}
func (*UnmarshalTypeError) String
func (e *UnmarshalTypeError) String() string
type Unmarshaler
Unmarshaler is the interface implemented by objects that can unmarshal a JSON description of themselves. The input can be assumed to be a valid JSON object encoding. UnmarshalJSON must copy the JSON data if it wishes to retain the data after returning.
type Unmarshaler interface {
UnmarshalJSON([]byte) os.Error
}
type UnsupportedTypeError
type UnsupportedTypeError struct {
Type reflect.Type
}
func (*UnsupportedTypeError) String
func (e *UnsupportedTypeError) String() string