package fastjson

Import Path
	github.com/valyala/fastjson (on go.dev)

Dependency Relation
	imports 9 packages, and imported by one package

Involved Source Files

	      arena.go
	   #d doc.go
		Package fastjson provides fast JSON parsing.

		Arbitrary JSON may be parsed by fastjson without the need for creating structs
		or for generating go code. Just parse JSON and get the required fields with
		Get* functions.

	      handy.go
	      parser.go
	      pool.go
	      scanner.go
	      update.go
	      util.go
	      validate.go
Package-Level Type Names (total 10, in which 8 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Arena (struct)
		Arena may be used for fast creation and re-use of Values.

		Typical Arena lifecycle:

		    1) Construct Values via the Arena and Value.Set* calls.
		    2) Marshal the constructed Values with Value.MarshalTo call.
		    3) Reset all the constructed Values at once by Arena.Reset call.
		    4) Go to 1 and re-use the Arena.

		It is unsafe calling Arena methods from concurrent goroutines.
		Use per-goroutine Arenas or ArenaPool instead.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			b []byte
			c cache
		Methods (total 11, all are exported)
			(*Arena) NewArray() *Value
				NewArray returns new empty array value.

				New entries may be added to the returned array via Set* calls.

				The returned array is valid until Reset is called on a.

			(*Arena) NewFalse() *Value
				NewFalse return false value.

			(*Arena) NewNull() *Value
				NewNull returns null value.

			(*Arena) NewNumberFloat64(f float64) *Value
				NewNumberFloat64 returns new number value containing f.

				The returned number is valid until Reset is called on a.

			(*Arena) NewNumberInt(n int) *Value
				NewNumberInt returns new number value containing n.

				The returned number is valid until Reset is called on a.

			(*Arena) NewNumberString(s string) *Value
				NewNumberString returns new number value containing s.

				The returned number is valid until Reset is called on a.

			(*Arena) NewObject() *Value
				NewObject returns new empty object value.

				New entries may be added to the returned object via Set call.

				The returned object is valid until Reset is called on a.

			(*Arena) NewString(s string) *Value
				NewString returns new string value containing s.

				The returned string is valid until Reset is called on a.

			(*Arena) NewStringBytes(b []byte) *Value
				NewStringBytes returns new string value containing b.

				The returned string is valid until Reset is called on a.

			(*Arena) NewTrue() *Value
				NewTrue returns true value.

			(*Arena) Reset()
				Reset resets all the Values allocated by a.

				Values previously allocated by a cannot be used after the Reset call.

		As Outputs Of (at least one exported)
			func (*ArenaPool).Get() *Arena
		As Inputs Of (at least one exported)
			func (*ArenaPool).Put(a *Arena)

	 type ArenaPool (struct)
		ArenaPool may be used for pooling Arenas for similarly typed JSONs.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			pool sync.Pool
		Methods (total 2, both are exported)
			(*ArenaPool) Get() *Arena
				Get returns an Arena from ap.

				The Arena must be Put to ap after use.

			(*ArenaPool) Put(a *Arena)
				Put returns a to ap.

				a and objects created by a cannot be used after a is put into ap.


	 type Object (struct)
		Object represents JSON object.

		Object cannot be used from concurrent goroutines.
		Use per-goroutine parsers or ParserPool instead.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			keysUnescaped bool
			kvs []kv
		Methods (total 10, in which 7 are exported)
			(*Object) Del(key string)
				Del deletes the entry with the given key from o.

			(*Object) Get(key string) *Value
				Get returns the value for the given key in the o.

				Returns nil if the value for the given key isn't found.

				The returned value is valid until Parse is called on the Parser returned o.

			(*Object) Len() int
				Len returns the number of items in the o.

			(*Object) MarshalTo(dst []byte) []byte
				MarshalTo appends marshaled o to dst and returns the result.

			(*Object) Set(key string, value *Value)
				Set sets (key, value) entry in the o.

				The value must be unchanged during o lifetime.

			(*Object) String() string
				String returns string representation for the o.

				This function is for debugging purposes only. It isn't optimized for speed.
				See MarshalTo instead.

			(*Object) Visit(f func(key []byte, v *Value))
				Visit calls f for each item in the o in the original order
				of the parsed JSON.

				f cannot hold key and/or v after returning.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			(*Object) getKV() *kv
			(*Object) reset()
			(*Object) unescapeKeys()
		Implements (at least 5, in which 2 are exported)
			*Object : expvar.Var
			*Object : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*Object : github.com/aws/smithy-go/middleware.stringer
			*Object : context.stringer
			*Object : runtime.stringer
		As Outputs Of (at least 3, in which 2 are exported)
			func (*Value).GetObject(keys ...string) *Object
			func (*Value).Object() (*Object, error)
			/* at least one unexported ... *//* at least one unexported: */
			func go.pact.im/x/zapjournal/tests.lastJournalMessage(pid int, message string) (*Object, error)

	 type Parser (struct)
		Parser parses JSON.

		Parser may be re-used for subsequent parsing.

		Parser cannot be used from concurrent goroutines.
		Use per-goroutine parsers or ParserPool instead.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			b []byte
			c cache
		Methods (total 2, both are exported)
			(*Parser) Parse(s string) (*Value, error)
				Parse parses s containing JSON.

				The returned value is valid until the next call to Parse*.

				Use Scanner if a stream of JSON values must be parsed.

			(*Parser) ParseBytes(b []byte) (*Value, error)
				ParseBytes parses b containing JSON.

				The returned Value is valid until the next call to Parse*.

				Use Scanner if a stream of JSON values must be parsed.

		As Outputs Of (at least one exported)
			func (*ParserPool).Get() *Parser
		As Inputs Of (at least one exported)
			func (*ParserPool).Put(p *Parser)

	 type ParserPool (struct)
		ParserPool may be used for pooling Parsers for similarly typed JSONs.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			pool sync.Pool
		Methods (total 2, both are exported)
			(*ParserPool) Get() *Parser
				Get returns a Parser from pp.

				The Parser must be Put to pp after use.

			(*ParserPool) Put(p *Parser)
				Put returns p to pp.

				p and objects recursively returned from p cannot be used after p
				is put into pp.

		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var handyPool

	 type Scanner (struct)
		Scanner scans a series of JSON values. Values may be delimited by whitespace.

		Scanner may parse JSON lines ( http://jsonlines.org/ ).

		Scanner may be re-used for subsequent parsing.

		Scanner cannot be used from concurrent goroutines.

		Use Parser for parsing only a single JSON value.

		Fields (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			b []byte
				b contains a working copy of json value passed to Init.

			c cache
				c is used for caching JSON values.

			err error
				err contains the last error.

			s string
				s points to the next JSON value to parse.

			v *Value
				v contains the last parsed JSON value.

		Methods (total 5, all are exported)
			(*Scanner) Error() error
				Error returns the last error.

			(*Scanner) Init(s string)
				Init initializes sc with the given s.

				s may contain multiple JSON values, which may be delimited by whitespace.

			(*Scanner) InitBytes(b []byte)
				InitBytes initializes sc with the given b.

				b may contain multiple JSON values, which may be delimited by whitespace.

			(*Scanner) Next() bool
				Next parses the next JSON value from s passed to Init.

				Returns true on success. The parsed value is available via Value call.

				Returns false either on error or on the end of s.
				Call Error in order to determine the cause of the returned false.

			(*Scanner) Value() *Value
				Value returns the last parsed value.

				The value is valid until the Next call.


	 type Type int (basic type)
		Type represents JSON type.

		Methods (only one, which is exported)
			( Type) String() string
				String returns string representation of t.

		Implements (at least 5, in which 2 are exported)
			 Type : expvar.Var
			 Type : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 Type : github.com/aws/smithy-go/middleware.stringer
			 Type : context.stringer
			 Type : runtime.stringer
		As Outputs Of (at least one exported)
			func (*Value).Type() Type
		As Types Of (total 8, in which 7 are exported)
			const TypeArray
			const TypeFalse
			const TypeNull
			const TypeNumber
			const TypeObject
			const TypeString
			const TypeTrue
			/* one unexported ... *//* one unexported: */
			const typeRawString

	 type Value (struct)
		Value represents any JSON value.

		Call Type in order to determine the actual type of the JSON value.

		Value cannot be used from concurrent goroutines.
		Use per-goroutine parsers or ParserPool instead.

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			a []*Value
			o Object
			s string
			t Type
		Methods (total 26, all are exported)
			(*Value) Array() ([]*Value, error)
				Array returns the underlying JSON array for the v.

				The returned array is valid until Parse is called on the Parser returned v.

				Use GetArray if you don't need error handling.

			(*Value) Bool() (bool, error)
				Bool returns the underlying JSON bool for the v.

				Use GetBool if you don't need error handling.

			(*Value) Del(key string)
				Del deletes the entry with the given key from array or object v.

			(*Value) Exists(keys ...string) bool
				Exists returns true if the field exists for the given keys path.

				Array indexes may be represented as decimal numbers in keys.

			(*Value) Float64() (float64, error)
				Float64 returns the underlying JSON number for the v.

				Use GetFloat64 if you don't need error handling.

			(*Value) Get(keys ...string) *Value
				Get returns value by the given keys path.

				Array indexes may be represented as decimal numbers in keys.

				nil is returned for non-existing keys path.

				The returned value is valid until Parse is called on the Parser returned v.

			(*Value) GetArray(keys ...string) []*Value
				GetArray returns array value by the given keys path.

				Array indexes may be represented as decimal numbers in keys.

				nil is returned for non-existing keys path or for invalid value type.

				The returned array is valid until Parse is called on the Parser returned v.

			(*Value) GetBool(keys ...string) bool
				GetBool returns bool value by the given keys path.

				Array indexes may be represented as decimal numbers in keys.

				false is returned for non-existing keys path or for invalid value type.

			(*Value) GetFloat64(keys ...string) float64
				GetFloat64 returns float64 value by the given keys path.

				Array indexes may be represented as decimal numbers in keys.

				0 is returned for non-existing keys path or for invalid value type.

			(*Value) GetInt(keys ...string) int
				GetInt returns int value by the given keys path.

				Array indexes may be represented as decimal numbers in keys.

				0 is returned for non-existing keys path or for invalid value type.

			(*Value) GetInt64(keys ...string) int64
				GetInt64 returns int64 value by the given keys path.

				Array indexes may be represented as decimal numbers in keys.

				0 is returned for non-existing keys path or for invalid value type.

			(*Value) GetObject(keys ...string) *Object
				GetObject returns object value by the given keys path.

				Array indexes may be represented as decimal numbers in keys.

				nil is returned for non-existing keys path or for invalid value type.

				The returned object is valid until Parse is called on the Parser returned v.

			(*Value) GetStringBytes(keys ...string) []byte
				GetStringBytes returns string value by the given keys path.

				Array indexes may be represented as decimal numbers in keys.

				nil is returned for non-existing keys path or for invalid value type.

				The returned string is valid until Parse is called on the Parser returned v.

			(*Value) GetUint(keys ...string) uint
				GetUint returns uint value by the given keys path.

				Array indexes may be represented as decimal numbers in keys.

				0 is returned for non-existing keys path or for invalid value type.

			(*Value) GetUint64(keys ...string) uint64
				GetUint64 returns uint64 value by the given keys path.

				Array indexes may be represented as decimal numbers in keys.

				0 is returned for non-existing keys path or for invalid value type.

			(*Value) Int() (int, error)
				Int returns the underlying JSON int for the v.

				Use GetInt if you don't need error handling.

			(*Value) Int64() (int64, error)
				Int64 returns the underlying JSON int64 for the v.

				Use GetInt64 if you don't need error handling.

			(*Value) MarshalTo(dst []byte) []byte
				MarshalTo appends marshaled v to dst and returns the result.

			(*Value) Object() (*Object, error)
				Object returns the underlying JSON object for the v.

				The returned object is valid until Parse is called on the Parser returned v.

				Use GetObject if you don't need error handling.

			(*Value) Set(key string, value *Value)
				Set sets (key, value) entry in the array or object v.

				The value must be unchanged during v lifetime.

			(*Value) SetArrayItem(idx int, value *Value)
				SetArrayItem sets the value in the array v at idx position.

				The value must be unchanged during v lifetime.

			(*Value) String() string
				String returns string representation of the v.

				The function is for debugging purposes only. It isn't optimized for speed.
				See MarshalTo instead.

				Don't confuse this function with StringBytes, which must be called
				for obtaining the underlying JSON string for the v.

			(*Value) StringBytes() ([]byte, error)
				StringBytes returns the underlying JSON string for the v.

				The returned string is valid until Parse is called on the Parser returned v.

				Use GetStringBytes if you don't need error handling.

			(*Value) Type() Type
				Type returns the type of the v.

			(*Value) Uint() (uint, error)
				Uint returns the underlying JSON uint for the v.

				Use GetInt if you don't need error handling.

			(*Value) Uint64() (uint64, error)
				Uint64 returns the underlying JSON uint64 for the v.

				Use GetInt64 if you don't need error handling.

		Implements (at least 5, in which 2 are exported)
			*Value : expvar.Var
			*Value : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*Value : github.com/aws/smithy-go/middleware.stringer
			*Value : context.stringer
			*Value : runtime.stringer
		As Outputs Of (at least 24, in which 21 are exported)
			func MustParse(s string) *Value
			func MustParseBytes(b []byte) *Value
			func Parse(s string) (*Value, error)
			func ParseBytes(b []byte) (*Value, error)
			func (*Arena).NewArray() *Value
			func (*Arena).NewFalse() *Value
			func (*Arena).NewNull() *Value
			func (*Arena).NewNumberFloat64(f float64) *Value
			func (*Arena).NewNumberInt(n int) *Value
			func (*Arena).NewNumberString(s string) *Value
			func (*Arena).NewObject() *Value
			func (*Arena).NewString(s string) *Value
			func (*Arena).NewStringBytes(b []byte) *Value
			func (*Arena).NewTrue() *Value
			func (*Object).Get(key string) *Value
			func (*Parser).Parse(s string) (*Value, error)
			func (*Parser).ParseBytes(b []byte) (*Value, error)
			func (*Scanner).Value() *Value
			func (*Value).Array() ([]*Value, error)
			func (*Value).Get(keys ...string) *Value
			func (*Value).GetArray(keys ...string) []*Value
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func parseArray(s string, c *cache, depth int) (*Value, string, error)
			func parseObject(s string, c *cache, depth int) (*Value, string, error)
			func parseValue(s string, c *cache, depth int) (*Value, string, error)
		As Inputs Of (at least 3, all are exported)
			func (*Object).Set(key string, value *Value)
			func (*Value).Set(key string, value *Value)
			func (*Value).SetArrayItem(idx int, value *Value)
		As Types Of (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			  var valueFalse *Value
			  var valueNull *Value
			  var valueTrue *Value

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type cache (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			vs []Value
		Methods (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*cache) getValue() *Value
			(*cache) reset()
		As Inputs Of (at least 3, none are exported)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func parseArray(s string, c *cache, depth int) (*Value, string, error)
			func parseObject(s string, c *cache, depth int) (*Value, string, error)
			func parseValue(s string, c *cache, depth int) (*Value, string, error)

	 type kv (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			k string
			v *Value
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func (*Object).getKV() *kv


Package-Level Functions (total 32, in which 12 are exported)

	 func Exists(data []byte, keys ...string) bool
		Exists returns true if the field identified by keys path exists in JSON data.

		Array indexes may be represented as decimal numbers in keys.

		False is returned on error. Use Parser for proper error handling.

		Parser is faster when multiple fields must be checked in the JSON.

	 func GetBool(data []byte, keys ...string) bool
		GetBool returns boolean value for the field identified by keys path
		in JSON data.

		Array indexes may be represented as decimal numbers in keys.

		False is returned on error. Use Parser for proper error handling.

		Parser is faster for obtaining multiple fields from JSON.

	 func GetBytes(data []byte, keys ...string) []byte
		GetBytes returns string value for the field identified by keys path
		in JSON data.

		Array indexes may be represented as decimal numbers in keys.

		nil is returned on error. Use Parser for proper error handling.

		Parser is faster for obtaining multiple fields from JSON.

	 func GetFloat64(data []byte, keys ...string) float64
		GetFloat64 returns float64 value for the field identified by keys path
		in JSON data.

		Array indexes may be represented as decimal numbers in keys.

		0 is returned on error. Use Parser for proper error handling.

		Parser is faster for obtaining multiple fields from JSON.

	 func GetInt(data []byte, keys ...string) int
		GetInt returns int value for the field identified by keys path
		in JSON data.

		Array indexes may be represented as decimal numbers in keys.

		0 is returned on error. Use Parser for proper error handling.

		Parser is faster for obtaining multiple fields from JSON.

	 func GetString(data []byte, keys ...string) string
		GetString returns string value for the field identified by keys path
		in JSON data.

		Array indexes may be represented as decimal numbers in keys.

		An empty string is returned on error. Use Parser for proper error handling.

		Parser is faster for obtaining multiple fields from JSON.

	 func MustParse(s string) *Value
		MustParse parses json string s.

		The function panics if s cannot be parsed.
		The function is slower than the Parser.Parse for re-used Parser.

	 func MustParseBytes(b []byte) *Value
		MustParseBytes parses b containing json.

		The function panics if b cannot be parsed.
		The function is slower than the Parser.ParseBytes for re-used Parser.

	 func Parse(s string) (*Value, error)
		Parse parses json string s.

		The function is slower than the Parser.Parse for re-used Parser.

	 func ParseBytes(b []byte) (*Value, error)
		ParseBytes parses b containing json.

		The function is slower than the Parser.ParseBytes for re-used Parser.

	 func Validate(s string) error
		Validate validates JSON s.

	 func ValidateBytes(b []byte) error
		ValidateBytes validates JSON b.

	/* 20 unexporteds ... *//* 20 unexporteds: */
	 func b2s(b []byte) string
	 func escapeString(dst []byte, s string) []byte
	 func hasSpecialChars(s string) bool
	 func parseArray(s string, c *cache, depth int) (*Value, string, error)
	 func parseObject(s string, c *cache, depth int) (*Value, string, error)
	 func parseRawKey(s string) (string, string, error)
		parseRawKey is similar to parseRawString, but is optimized
		for small-sized keys without escape sequences.

	 func parseRawNumber(s string) (string, string, error)
	 func parseRawString(s string) (string, string, error)
	 func parseValue(s string, c *cache, depth int) (*Value, string, error)
	 func s2b(s string) (b []byte)
	 func skipWS(s string) string
	 func skipWSSlow(s string) string
	 func startEndString(s string) string
	 func unescapeStringBestEffort(s string) string
	 func validateArray(s string) (string, error)
	 func validateKey(s string) (string, string, error)
		validateKey is similar to validateString, but is optimized
		for typical object keys, which are quite small and have no escape sequences.

	 func validateNumber(s string) (string, error)
	 func validateObject(s string) (string, error)
	 func validateString(s string) (string, string, error)
	 func validateValue(s string) (string, error)
Package-Level Variables (total 5, none are exported)

	/* 5 unexporteds ... *//* 5 unexporteds: */
	  var errEOF error
	  var handyPool ParserPool
	  var valueFalse *Value
	  var valueNull *Value
	  var valueTrue *Value
Package-Level Constants (total 10, in which 8 are exported)

	const MaxDepth = 300
		MaxDepth is the maximum depth for nested JSON.

	const TypeArray Type = 2
		TypeArray is JSON array type.

	const TypeFalse Type = 6
		TypeFalse is JSON false.

	const TypeNull Type = 0
		TypeNull is JSON null.

	const TypeNumber Type = 4
		TypeNumber is JSON number type.

	const TypeObject Type = 1
		TypeObject is JSON object type.

	const TypeString Type = 3
		TypeString is JSON string type.

	const TypeTrue Type = 5
		TypeTrue is JSON true.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	const maxStartEndStringLen = 80
	const typeRawString Type = 7

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)