Documentation
¶
Overview ¶
package jsoner implements encoding and decoding of JSON as defined in RFC 4627 and provides interfaces with identical syntax of standard lib encoding/json. Converting from encoding/json to jsoner is no more than replacing the package with jsoner and variable type declarations (if any). jsoner interfaces gives 100% compatibility with code using standard lib.
"JSON and Go" (https://golang.org/doc/articles/json_and_go.html) gives a description of how Marshal/Unmarshal operate between arbitrary or predefined json objects and bytes, and it applies to jsoner.Marshal/Unmarshal as well.
Besides, jsoner.Iterator provides a different set of interfaces iterating given bytes/string/reader and yielding parsed elements one by one. This set of interfaces reads input as required and gives better performance.
Index ¶
- func CastJsonNumber(val interface{}) (string, bool)
- type API
- type Any
- type Binding
- type Config
- type DecoderExtension
- func (extension DecoderExtension) CreateDecoder(typ reflect2.Type) ValDecoder
- func (extension DecoderExtension) CreateEncoder(typ reflect2.Type) ValEncoder
- func (extension DecoderExtension) CreateMapKeyDecoder(typ reflect2.Type) ValDecoder
- func (extension DecoderExtension) CreateMapKeyEncoder(typ reflect2.Type) ValEncoder
- func (extension DecoderExtension) DecorateDecoder(typ reflect2.Type, decoder ValDecoder) ValDecoder
- func (extension DecoderExtension) DecorateEncoder(typ reflect2.Type, encoder ValEncoder) ValEncoder
- func (extension DecoderExtension) UpdateStructDescriptor(structDescriptor *StructDescriptor)
- type DecoderFunc
- type DummyExtension
- func (extension *DummyExtension) CreateDecoder(typ reflect2.Type) ValDecoder
- func (extension *DummyExtension) CreateEncoder(typ reflect2.Type) ValEncoder
- func (extension *DummyExtension) CreateMapKeyDecoder(typ reflect2.Type) ValDecoder
- func (extension *DummyExtension) CreateMapKeyEncoder(typ reflect2.Type) ValEncoder
- func (extension *DummyExtension) DecorateDecoder(typ reflect2.Type, decoder ValDecoder) ValDecoder
- func (extension *DummyExtension) DecorateEncoder(typ reflect2.Type, encoder ValEncoder) ValEncoder
- func (extension *DummyExtension) UpdateStructDescriptor(structDescriptor *StructDescriptor)
- type EncoderExtension
- func (extension EncoderExtension) CreateDecoder(typ reflect2.Type) ValDecoder
- func (extension EncoderExtension) CreateEncoder(typ reflect2.Type) ValEncoder
- func (extension EncoderExtension) CreateMapKeyDecoder(typ reflect2.Type) ValDecoder
- func (extension EncoderExtension) CreateMapKeyEncoder(typ reflect2.Type) ValEncoder
- func (extension EncoderExtension) DecorateDecoder(typ reflect2.Type, decoder ValDecoder) ValDecoder
- func (extension EncoderExtension) DecorateEncoder(typ reflect2.Type, encoder ValEncoder) ValEncoder
- func (extension EncoderExtension) UpdateStructDescriptor(structDescriptor *StructDescriptor)
- type EncoderFunc
- type Extension
- type IsEmbeddedPtrNil
- type Iterator
- func (iter *Iterator) CurrentBuffer() string
- func (iter *Iterator) Pool() IteratorPool
- func (iter *Iterator) Read() interface{}
- func (iter *Iterator) ReadAny() Any
- func (iter *Iterator) ReadArray() (ret bool)
- func (iter *Iterator) ReadArrayCB(callback func(*Iterator) bool) (ret bool)
- func (iter *Iterator) ReadBigFloat() (ret *big.Float)
- func (iter *Iterator) ReadBigInt() (ret *big.Int)
- func (iter *Iterator) ReadBool() (ret bool)
- func (iter *Iterator) ReadFloat32() (ret float32)
- func (iter *Iterator) ReadFloat64() (ret float64)
- func (iter *Iterator) ReadInt() int
- func (iter *Iterator) ReadInt16() (ret int16)
- func (iter *Iterator) ReadInt32() (ret int32)
- func (iter *Iterator) ReadInt64() (ret int64)
- func (iter *Iterator) ReadInt8() (ret int8)
- func (iter *Iterator) ReadMapCB(callback func(*Iterator, string) bool) bool
- func (iter *Iterator) ReadNil() (ret bool)
- func (iter *Iterator) ReadNumber() (ret json.Number)
- func (iter *Iterator) ReadObject() (ret string)
- func (iter *Iterator) ReadObjectCB(callback func(*Iterator, string) bool) bool
- func (iter *Iterator) ReadString() (ret string)
- func (iter *Iterator) ReadStringAsSlice() (ret []byte)
- func (iter *Iterator) ReadUint() uint
- func (iter *Iterator) ReadUint16() (ret uint16)
- func (iter *Iterator) ReadUint32() (ret uint32)
- func (iter *Iterator) ReadUint64() uint64
- func (iter *Iterator) ReadUint8() (ret uint8)
- func (iter *Iterator) ReadVal(obj interface{})
- func (iter *Iterator) ReportError(operation string, msg string)
- func (iter *Iterator) Reset(reader io.Reader) *Iterator
- func (iter *Iterator) ResetBytes(input []byte) *Iterator
- func (iter *Iterator) Skip()
- func (iter *Iterator) SkipAndAppendBytes(buf []byte) []byte
- func (iter *Iterator) SkipAndReturnBytes() []byte
- func (iter *Iterator) WhatIsNext() ValueType
- type IteratorPool
- type Map
- type Number
- type OptionalDecoder
- type OptionalEncoder
- type RawMessage
- type Stream
- func (stream *Stream) Available() int
- func (stream *Stream) Buffer() []byte
- func (stream *Stream) Buffered() int
- func (stream *Stream) Flush() error
- func (stream *Stream) Pool() StreamPool
- func (stream *Stream) Reset(out io.Writer)
- func (stream *Stream) SetBuffer(buf []byte)
- func (stream *Stream) Write(p []byte) (nn int, err error)
- func (stream *Stream) WriteArrayEnd()
- func (stream *Stream) WriteArrayStart()
- func (stream *Stream) WriteBool(val bool)
- func (stream *Stream) WriteEmptyArray()
- func (stream *Stream) WriteEmptyObject()
- func (stream *Stream) WriteFalse()
- func (stream *Stream) WriteFloat32(val float32)
- func (stream *Stream) WriteFloat32Lossy(val float32)
- func (stream *Stream) WriteFloat64(val float64)
- func (stream *Stream) WriteFloat64Lossy(val float64)
- func (stream *Stream) WriteInt(val int)
- func (stream *Stream) WriteInt16(nval int16)
- func (stream *Stream) WriteInt32(nval int32)
- func (stream *Stream) WriteInt64(nval int64)
- func (stream *Stream) WriteInt8(nval int8)
- func (stream *Stream) WriteMore()
- func (stream *Stream) WriteNil()
- func (stream *Stream) WriteObjectEnd()
- func (stream *Stream) WriteObjectField(field string)
- func (stream *Stream) WriteObjectStart()
- func (stream *Stream) WriteRaw(s string)
- func (stream *Stream) WriteString(s string)
- func (stream *Stream) WriteStringWithHTMLEscaped(s string)
- func (stream *Stream) WriteTrue()
- func (stream *Stream) WriteUint(val uint)
- func (stream *Stream) WriteUint16(val uint16)
- func (stream *Stream) WriteUint32(val uint32)
- func (stream *Stream) WriteUint64(val uint64)
- func (stream *Stream) WriteUint8(val uint8)
- func (stream *Stream) WriteVal(val interface{})
- type StreamPool
- type StructDescriptor
- type ValDecoder
- type ValEncoder
- type ValueType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CastJsonNumber ¶
Types ¶
type API ¶
type API interface { IteratorPool StreamPool MarshalToString(v interface{}) (string, error) Marshal(v interface{}) ([]byte, error) MarshalIndent(v interface{}, prefix, indent string) ([]byte, error) UnmarshalFromString(str string, v interface{}) error Unmarshal(data []byte, v interface{}) error Get(data []byte, path ...interface{}) Any RegisterExtension(extension Extension) RegisterFieldEncoderFunc(typ string, field string, fun EncoderFunc, isEmptyFunc func(unsafe.Pointer) bool) RegisterFieldEncoder(typ string, field string, encoder ValEncoder) RegisterTypeEncoder(typ string, encoder ValEncoder) RegisterTypeEncoderFunc(typ string, fun EncoderFunc, isEmptyFunc func(unsafe.Pointer) bool) RegisterTypeDecoderFunc(typ string, fun DecoderFunc) RegisterTypeDecoder(typ string, decoder ValDecoder) RegisterFieldDecoderFunc(typ string, field string, fun DecoderFunc) RegisterFieldDecoder(typ string, field string, decoder ValDecoder) ClearExtensions() ClearDecoders() ClearEncoders() DecoderOf(typ reflect2.Type) ValDecoder EncoderOf(typ reflect2.Type) ValEncoder }
API the public interface of this package. Primary Marshal and Unmarshal.
func CompatibleAPI ¶
func CompatibleAPI() API
CompatibleAPI tries to be 100% compatible with standard library behavior
type Any ¶
type Any interface { LastError() error ValueType() ValueType MustBeValid() Any ToBool() bool ToInt() int ToInt32() int32 ToInt64() int64 ToUint() uint ToUint32() uint32 ToUint64() uint64 ToFloat32() float32 ToFloat64() float64 ToString() string ToVal(val interface{}) Get(path ...interface{}) Any Size() int Keys() []string GetInterface() interface{} WriteTo(stream *Stream) }
Any generic object representation. The lazy json implementation holds []byte and parse lazily.
type Binding ¶
type Binding struct { Field reflect2.StructField FromNames []string ToNames []string Encoder ValEncoder Decoder ValDecoder // contains filtered or unexported fields }
Binding describe how should we encode/decode the struct field
type Config ¶
type Config struct { IndentionStep int MarshalFloatWith6Digits bool EscapeHTML bool SortMapKeys bool UseNumber bool DisallowUnknownFields bool TagKey string OnlyTaggedField bool ValidateJsonRawMessage bool ObjectFieldMustBeSimpleString bool CaseSensitive bool }
Config customize how the API should behave. The API is created from Config by Froze.
type DecoderExtension ¶
type DecoderExtension map[reflect2.Type]ValDecoder
func (DecoderExtension) CreateDecoder ¶
func (extension DecoderExtension) CreateDecoder(typ reflect2.Type) ValDecoder
CreateDecoder get decoder from map
func (DecoderExtension) CreateEncoder ¶
func (extension DecoderExtension) CreateEncoder(typ reflect2.Type) ValEncoder
CreateEncoder No-op
func (DecoderExtension) CreateMapKeyDecoder ¶
func (extension DecoderExtension) CreateMapKeyDecoder(typ reflect2.Type) ValDecoder
CreateMapKeyDecoder No-op
func (DecoderExtension) CreateMapKeyEncoder ¶
func (extension DecoderExtension) CreateMapKeyEncoder(typ reflect2.Type) ValEncoder
CreateMapKeyEncoder No-op
func (DecoderExtension) DecorateDecoder ¶
func (extension DecoderExtension) DecorateDecoder(typ reflect2.Type, decoder ValDecoder) ValDecoder
DecorateDecoder No-op
func (DecoderExtension) DecorateEncoder ¶
func (extension DecoderExtension) DecorateEncoder(typ reflect2.Type, encoder ValEncoder) ValEncoder
DecorateEncoder No-op
func (DecoderExtension) UpdateStructDescriptor ¶
func (extension DecoderExtension) UpdateStructDescriptor(structDescriptor *StructDescriptor)
UpdateStructDescriptor No-op
type DecoderFunc ¶
DecoderFunc the function form of TypeDecoder
type DummyExtension ¶
type DummyExtension struct { }
DummyExtension embed this type get dummy implementation for all methods of Extension
func (*DummyExtension) CreateDecoder ¶
func (extension *DummyExtension) CreateDecoder(typ reflect2.Type) ValDecoder
CreateDecoder No-op
func (*DummyExtension) CreateEncoder ¶
func (extension *DummyExtension) CreateEncoder(typ reflect2.Type) ValEncoder
CreateEncoder No-op
func (*DummyExtension) CreateMapKeyDecoder ¶
func (extension *DummyExtension) CreateMapKeyDecoder(typ reflect2.Type) ValDecoder
CreateMapKeyDecoder No-op
func (*DummyExtension) CreateMapKeyEncoder ¶
func (extension *DummyExtension) CreateMapKeyEncoder(typ reflect2.Type) ValEncoder
CreateMapKeyEncoder No-op
func (*DummyExtension) DecorateDecoder ¶
func (extension *DummyExtension) DecorateDecoder(typ reflect2.Type, decoder ValDecoder) ValDecoder
DecorateDecoder No-op
func (*DummyExtension) DecorateEncoder ¶
func (extension *DummyExtension) DecorateEncoder(typ reflect2.Type, encoder ValEncoder) ValEncoder
DecorateEncoder No-op
func (*DummyExtension) UpdateStructDescriptor ¶
func (extension *DummyExtension) UpdateStructDescriptor(structDescriptor *StructDescriptor)
UpdateStructDescriptor No-op
type EncoderExtension ¶
type EncoderExtension map[reflect2.Type]ValEncoder
func (EncoderExtension) CreateDecoder ¶
func (extension EncoderExtension) CreateDecoder(typ reflect2.Type) ValDecoder
CreateDecoder No-op
func (EncoderExtension) CreateEncoder ¶
func (extension EncoderExtension) CreateEncoder(typ reflect2.Type) ValEncoder
CreateEncoder get encoder from map
func (EncoderExtension) CreateMapKeyDecoder ¶
func (extension EncoderExtension) CreateMapKeyDecoder(typ reflect2.Type) ValDecoder
CreateMapKeyDecoder No-op
func (EncoderExtension) CreateMapKeyEncoder ¶
func (extension EncoderExtension) CreateMapKeyEncoder(typ reflect2.Type) ValEncoder
CreateMapKeyEncoder No-op
func (EncoderExtension) DecorateDecoder ¶
func (extension EncoderExtension) DecorateDecoder(typ reflect2.Type, decoder ValDecoder) ValDecoder
DecorateDecoder No-op
func (EncoderExtension) DecorateEncoder ¶
func (extension EncoderExtension) DecorateEncoder(typ reflect2.Type, encoder ValEncoder) ValEncoder
DecorateEncoder No-op
func (EncoderExtension) UpdateStructDescriptor ¶
func (extension EncoderExtension) UpdateStructDescriptor(structDescriptor *StructDescriptor)
UpdateStructDescriptor No-op
type EncoderFunc ¶
EncoderFunc the function form of TypeEncoder
type Extension ¶
type Extension interface { UpdateStructDescriptor(structDescriptor *StructDescriptor) CreateMapKeyDecoder(typ reflect2.Type) ValDecoder CreateMapKeyEncoder(typ reflect2.Type) ValEncoder CreateDecoder(typ reflect2.Type) ValDecoder CreateEncoder(typ reflect2.Type) ValEncoder DecorateDecoder(typ reflect2.Type, decoder ValDecoder) ValDecoder DecorateEncoder(typ reflect2.Type, encoder ValEncoder) ValEncoder }
Extension the one for all SPI. Customize encoding/decoding by specifying alternate encoder/decoder. Can also rename fields by UpdateStructDescriptor.
type IsEmbeddedPtrNil ¶
type Iterator ¶
type Iterator struct { Error error Attachment interface{} // open for customized decoder // contains filtered or unexported fields }
Iterator is a io.Reader like object, with JSON specific read functions. Error is not returned as return value, but stored as Error member on this iterator instance.
func NewIterator ¶
NewIterator creates an empty Iterator instance
func ParseBytes ¶
ParseBytes creates an Iterator instance from byte array
func ParseString ¶
ParseString creates an Iterator instance from string
func (*Iterator) CurrentBuffer ¶
CurrentBuffer gets current buffer as string for debugging purpose
func (*Iterator) Pool ¶
func (iter *Iterator) Pool() IteratorPool
Pool returns a pool can provide more iterator with same configuration
func (*Iterator) Read ¶
func (iter *Iterator) Read() interface{}
Read read the next JSON element as generic interface{}.
func (*Iterator) ReadAny ¶
ReadAny read next JSON element as an Any object. It is a better json.RawMessage.
func (*Iterator) ReadArray ¶
ReadArray read array element, tells if the array has more element to read.
func (*Iterator) ReadArrayCB ¶
ReadArrayCB read array with callback
func (*Iterator) ReadBigFloat ¶
ReadBigFloat read big.Float
func (*Iterator) ReadBigInt ¶
ReadBigInt read big.Int
func (*Iterator) ReadFloat32 ¶
ReadFloat32 read float32
func (*Iterator) ReadFloat64 ¶
ReadFloat64 read float64
func (*Iterator) ReadNumber ¶
ReadNumber read json.Number
func (*Iterator) ReadObject ¶
ReadObject read one field from object. If object ended, returns empty string. Otherwise, returns the field name.
func (*Iterator) ReadObjectCB ¶
ReadObjectCB read object with callback, the key is ascii only and field name not copied
func (*Iterator) ReadString ¶
ReadString read string from iterator
func (*Iterator) ReadStringAsSlice ¶
ReadStringAsSlice read string from iterator without copying into string form. The []byte can not be kept, as it will change after next iterator call.
func (*Iterator) ReadUint16 ¶
ReadUint16 read uint16
func (*Iterator) ReadUint32 ¶
ReadUint32 read uint32
func (*Iterator) ReadVal ¶
func (iter *Iterator) ReadVal(obj interface{})
ReadVal copy the underlying JSON into go interface, same as json.Unmarshal
func (*Iterator) ReportError ¶
ReportError record a error in iterator instance with current position.
func (*Iterator) ResetBytes ¶
ResetBytes reuse iterator instance by specifying another byte array as input
func (*Iterator) Skip ¶
func (iter *Iterator) Skip()
Skip skips a json object and positions to relatively the next json object
func (*Iterator) SkipAndAppendBytes ¶
SkipAndAppendBytes skips next JSON element and appends its content to buffer, returning the result.
func (*Iterator) SkipAndReturnBytes ¶
SkipAndReturnBytes skip next JSON element, and return its content as []byte. The []byte can be kept, it is a copy of data.
func (*Iterator) WhatIsNext ¶
WhatIsNext gets ValueType of relatively next json element
type IteratorPool ¶
type IteratorPool interface { BorrowIterator(data []byte) *Iterator ReturnIterator(iter *Iterator) }
IteratorPool a thread safe pool of iterators with same configuration
type Map ¶
type Map struct {
// contains filtered or unexported fields
}
type OptionalDecoder ¶
type OptionalDecoder struct { ValueType reflect2.Type ValueDecoder ValDecoder }
type OptionalEncoder ¶
type OptionalEncoder struct {
ValueEncoder ValEncoder
}
type RawMessage ¶
type RawMessage []byte
type Stream ¶
type Stream struct { Error error Attachment interface{} // open for customized encoder // contains filtered or unexported fields }
stream is a io.Writer like object, with JSON specific write functions. Error is not returned as return value, but stored as Error member on this stream instance.
func NewStream ¶
NewStream create new stream instance. cfg can be jsoner.ConfigDefault. out can be nil if write to internal buffer. bufSize is the initial size for the internal buffer in bytes.
func (*Stream) Buffered ¶
Buffered returns the number of bytes that have been written into the current buffer.
func (*Stream) Pool ¶
func (stream *Stream) Pool() StreamPool
Pool returns a pool can provide more stream with same configuration
func (*Stream) Write ¶
Write writes the contents of p into the buffer. It returns the number of bytes written. If nn < len(p), it also returns an error explaining why the write is short.
func (*Stream) WriteArrayEnd ¶
func (stream *Stream) WriteArrayEnd()
WriteArrayEnd write ] with possible indention
func (*Stream) WriteArrayStart ¶
func (stream *Stream) WriteArrayStart()
WriteArrayStart write [ with possible indention
func (*Stream) WriteEmptyObject ¶
func (stream *Stream) WriteEmptyObject()
WriteEmptyObject write {}
func (*Stream) WriteFloat32 ¶
WriteFloat32 write float32 to stream
func (*Stream) WriteFloat32Lossy ¶
WriteFloat32Lossy write float32 to stream with ONLY 6 digits precision although much much faster
func (*Stream) WriteFloat64 ¶
WriteFloat64 write float64 to stream
func (*Stream) WriteFloat64Lossy ¶
WriteFloat64Lossy write float64 to stream with ONLY 6 digits precision although much much faster
func (*Stream) WriteInt16 ¶
WriteInt16 write int16 to stream
func (*Stream) WriteInt32 ¶
WriteInt32 write int32 to stream
func (*Stream) WriteInt64 ¶
WriteInt64 write int64 to stream
func (*Stream) WriteMore ¶
func (stream *Stream) WriteMore()
WriteMore write , with possible indention
func (*Stream) WriteObjectEnd ¶
func (stream *Stream) WriteObjectEnd()
WriteObjectEnd write } with possible indention
func (*Stream) WriteObjectField ¶
WriteObjectField write "field": with possible indention
func (*Stream) WriteObjectStart ¶
func (stream *Stream) WriteObjectStart()
WriteObjectStart write { with possible indention
func (*Stream) WriteString ¶
WriteString write string to stream without html escape
func (*Stream) WriteStringWithHTMLEscaped ¶
WriteStringWithHTMLEscaped write string to stream with html special characters escaped
func (*Stream) WriteUint16 ¶
WriteUint16 write uint16 to stream
func (*Stream) WriteUint32 ¶
WriteUint32 write uint32 to stream
func (*Stream) WriteUint64 ¶
WriteUint64 write uint64 to stream
func (*Stream) WriteUint8 ¶
WriteUint8 write uint8 to stream
type StreamPool ¶
StreamPool a thread safe pool of streams with same configuration
type StructDescriptor ¶
StructDescriptor describe how should we encode/decode the struct
func (*StructDescriptor) GetField ¶
func (structDescriptor *StructDescriptor) GetField(fieldName string) *Binding
GetField get one field from the descriptor by its name. Can not use map here to keep field orders.
type ValDecoder ¶
ValDecoder is an internal type registered to cache as needed. Don't confuse jsoner.ValDecoder with json.Decoder. For json.Decoder's adapter, refer to jsoner.AdapterDecoder(todo link).
Reflection on type to create decoders, which is then cached Reflection on value is avoided as we can, as the reflect.Value itself will allocate, with following exceptions 1. create instance of new value, for example *int will need a int to be allocated 2. append to slice, if the existing cap is not enough, allocate will be done using Reflect.New 3. assignment to map, both key and value will be reflect.Value For a simple struct binding, it will be reflect.Value free and allocation free
type ValEncoder ¶
type ValEncoder interface { IsEmpty(ptr unsafe.Pointer) bool Encode(ptr unsafe.Pointer, stream *Stream) }
ValEncoder is an internal type registered to cache as needed. Don't confuse jsoner.ValEncoder with json.Encoder. For json.Encoder's adapter, refer to jsoner.AdapterEncoder(todo godoc link).
type ValueType ¶
type ValueType int
ValueType the type for JSON element
const ( // InvalidValue invalid JSON element InvalidValue ValueType = iota // StringValue JSON element "string" StringValue // NumberValue JSON element 100 or 0.10 NumberValue // NilValue JSON element null NilValue // BoolValue JSON element true or false BoolValue // ArrayValue JSON element [] ArrayValue // ObjectValue JSON element {} ObjectValue )
Source Files
¶
- any.go
- any_array.go
- any_bool.go
- any_float.go
- any_int32.go
- any_int64.go
- any_invalid.go
- any_nil.go
- any_number.go
- any_object.go
- any_str.go
- any_uint32.go
- any_uint64.go
- config.go
- iter.go
- iter_array.go
- iter_float.go
- iter_int.go
- iter_object.go
- iter_skip.go
- iter_skip_strict.go
- iter_str.go
- jsoniter.go
- map.go
- pool.go
- reflect.go
- reflect_array.go
- reflect_dynamic.go
- reflect_extension.go
- reflect_json_number.go
- reflect_json_raw_message.go
- reflect_map.go
- reflect_marshaler.go
- reflect_native.go
- reflect_optional.go
- reflect_slice.go
- reflect_struct_decoder.go
- reflect_struct_encoder.go
- stream.go
- stream_float.go
- stream_int.go
- stream_str.go