From 404c0ee44b46e6891df2da0657ddb3a9ed97ce6d Mon Sep 17 00:00:00 2001 From: nifei Date: Mon, 5 Jun 2017 19:57:20 +0800 Subject: [PATCH] Decoder doc --- feature_adapter.go | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/feature_adapter.go b/feature_adapter.go index 3ed0bc7..72f8b65 100644 --- a/feature_adapter.go +++ b/feature_adapter.go @@ -8,9 +8,7 @@ import ( // Unmarshal adapts to json/encoding Unmarshal API // // Unmarshal parses the JSON-encoded data and stores the result in the value pointed to by v. -// https://godoc.org/encoding/json#Unmarshal -// linktest: https://godoc.org/encoding/json#Unmarshal -// link test +// Refer to https://godoc.org/encoding/json#Unmarshal for more information func Unmarshal(data []byte, v interface{}) error { data = data[:lastNotSpacePos(data)] iter := ParseBytes(data) @@ -89,6 +87,7 @@ func UnmarshalAnyFromString(str string) (Any, error) { // Marshal adapts to json/encoding Marshal API // // Marshal returns the JSON encoding of v, adapts to json/encoding Marshal API +// Refer to https://godoc.org/encoding/json#Marshal for more information func Marshal(v interface{}) ([]byte, error) { buf := &bytes.Buffer{} stream := NewStream(buf, 512) @@ -111,11 +110,16 @@ func MarshalToString(v interface{}) (string, error) { // NewDecoder adapts to json/stream NewDecoder API. // // NewDecoder returns a new decoder that reads from r. +// +// Instead of a json/encoding Decoder, an AdaptedDecoder is returned +// Refer to https://godoc.org/encoding/json#NewDecoder for more information func NewDecoder(reader io.Reader) *AdaptedDecoder { iter := Parse(reader, 512) return &AdaptedDecoder{iter} } +// AdaptedDecoder reads and decodes JSON values from an input stream. +// AdaptedDecoder provides identical APIs with json/stream Decoder (Token() and UseNumber() are in progress) type AdaptedDecoder struct { iter *Iterator }