package jsonparser

Import Path
	github.com/buger/jsonparser (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	    bytes.go
	    bytes_unsafe.go
	    escape.go
	    fuzz.go
	    parser.go
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type ValueType int (basic type)
		Data types available in valid JSON data.

		Methods (only one)
			( ValueType) String() string
		Implements (at least 2)
			 ValueType : expvar.Var
			 ValueType : fmt.Stringer
		As Outputs Of (at least one exported)
			func Get(data []byte, keys ...string) (value []byte, dataType ValueType, offset int, err error)
		As Types Of (total 8)
			const Array
			const Boolean
			const NotExist
			const Null
			const Number
			const Object
			const String
			const Unknown


Package-Level Functions (total 32)

	 func ArrayEach(data []byte, cb func(value []byte, dataType ValueType, offset int, err error), keys ...string) (offset int, err error)
		ArrayEach is used when iterating arrays, accepts a callback function with the same return arguments as `Get`.

	 func Delete(data []byte, keys ...string) []byte
		Del - Receives existing data structure, path to delete.
		
		Returns:
		`data` - return modified data

	 func EachKey(data []byte, cb func(int, []byte, ValueType, error), paths ...[]string) int
	 func FuzzDelete(data []byte) int
	 func FuzzEachKey(data []byte) int
	 func FuzzGetBoolean(data []byte) int
	 func FuzzGetFloat(data []byte) int
	 func FuzzGetInt(data []byte) int
	 func FuzzGetString(data []byte) int
	 func FuzzGetUnsafeString(data []byte) int
	 func FuzzObjectEach(data []byte) int
	 func FuzzParseBool(data []byte) int
	 func FuzzParseFloat(data []byte) int
	 func FuzzParseInt(data []byte) int
	 func FuzzParseString(data []byte) int
	 func FuzzSet(data []byte) int
	 func FuzzTokenStart(data []byte) int
	 func Get(data []byte, keys ...string) (value []byte, dataType ValueType, offset int, err error)
		Get - Receives data structure, and key path to extract value from.
		
		Returns:
		`value` - Pointer to original data structure containing key value, or just empty slice if nothing found or error
		`dataType` -    Can be: `NotExist`, `String`, `Number`, `Object`, `Array`, `Boolean` or `Null`
		`offset` - Offset from provided data structure where key value ends. Used mostly internally, for example for `ArrayEach` helper.
		`err` - If key not found or any other parsing issue it should return error. If key not found it also sets `dataType` to `NotExist`
		
		Accept multiple keys to specify path to JSON value (in case of quering nested structures).
		If no keys provided it will try to extract closest JSON value (simple ones or object/array), useful for reading streams or arrays, see `ArrayEach` implementation.

	 func GetBoolean(data []byte, keys ...string) (val bool, err error)
		GetBoolean returns the value retrieved by `Get`, cast to a bool if possible.
		The offset is the same as in `Get`.
		If key data type do not match, it will return error.

	 func GetFloat(data []byte, keys ...string) (val float64, err error)
		GetFloat returns the value retrieved by `Get`, cast to a float64 if possible.
		The offset is the same as in `Get`.
		If key data type do not match, it will return an error.

	 func GetInt(data []byte, keys ...string) (val int64, err error)
		GetInt returns the value retrieved by `Get`, cast to a int64 if possible.
		If key data type do not match, it will return an error.

	 func GetString(data []byte, keys ...string) (val string, err error)
		GetString returns the value retrieved by `Get`, cast to a string if possible, trying to properly handle escape and utf8 symbols
		If key data type do not match, it will return an error.

	 func GetUnsafeString(data []byte, keys ...string) (val string, err error)
		GetUnsafeString returns the value retrieved by `Get`, use creates string without memory allocation by mapping string to slice memory. It does not handle escape symbols.

	 func ObjectEach(data []byte, callback func(key []byte, value []byte, dataType ValueType, offset int) error, keys ...string) (err error)
		ObjectEach iterates over the key-value pairs of a JSON object, invoking a given callback for each such entry

	 func ParseBoolean(b []byte) (bool, error)
		ParseBoolean parses a Boolean ValueType into a Go bool (not particularly useful, but here for completeness)

	 func ParseFloat(b []byte) (float64, error)
		ParseNumber parses a Number ValueType into a Go float64

	 func ParseInt(b []byte) (int64, error)
		ParseInt parses a Number ValueType into a Go int64

	 func ParseString(b []byte) (string, error)
		ParseString parses a String ValueType into a Go string (the main parsing work is unescaping the JSON string)

	 func Set(data []byte, setValue []byte, keys ...string) (value []byte, err error)
		Set - Receives existing data structure, path to set, and data to set at that key.
		
		Returns:
		`value` - modified byte array
		`err` - On any parsing error

	 func StringToBytes(s string) []byte
	 func Unescape(in, out []byte) ([]byte, error)
		unescape unescapes the string contained in 'in' and returns it as a slice.
		If 'in' contains no escaped characters:
		  Returns 'in'.
		Else, if 'out' is of sufficient capacity (guaranteed if cap(out) >= len(in)):
		  'out' is used to build the unescaped string and is returned with no extra allocation
		Else:
		  A new slice is allocated and returned.

	 func WriteToBuffer(buffer []byte, str string) int
Package-Level Variables (total 9)

	  var KeyPathNotFoundError error
		Errors

	  var MalformedArrayError error
		Errors

	  var MalformedJsonError error
		Errors

	  var MalformedObjectError error
		Errors

	  var MalformedStringError error
		Errors

	  var MalformedStringEscapeError error
		Errors

	  var MalformedValueError error
		Errors

	  var OverflowIntegerError error
		Errors

	  var UnknownValueTypeError error
		Errors


Package-Level Constants (total 8)

	const Array ValueType = 4
	const Boolean ValueType = 5
	const NotExist ValueType = 0
	const Null ValueType = 6
	const Number ValueType = 2
	const Object ValueType = 3
	const String ValueType = 1
	const Unknown ValueType = 7

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.