package json

Import Path
	google.golang.org/protobuf/internal/encoding/json (on go.dev)

Dependency Relation
	imports 14 packages, and imported by one package

Involved Source Files

	    decode.go
	    decode_number.go
	    decode_string.go
	    decode_token.go
	    encode.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type Decoder (struct)
		Decoder is a token-based JSON decoder.

		Methods (total 4)
			(*Decoder) Clone() *Decoder
				Clone returns a copy of the Decoder for use in reading ahead the next JSON
				object, array or other values without affecting current Decoder.

			(*Decoder) Peek() (Token, error)
				Peek looks ahead and returns the next token kind without advancing a read.

			(*Decoder) Position(idx int) (line int, column int)
				Position returns line and column number of given index of the original input.
				It will panic if index is out of range.

			(*Decoder) Read() (Token, error)
				Read returns the next JSON token.
				It will return an error if there is no valid token.

		As Outputs Of (at least 2)
			func NewDecoder(b []byte) *Decoder
			func (*Decoder).Clone() *Decoder

	 type Encoder (struct)
		Encoder provides methods to write out JSON constructs and values. The user is
		responsible for producing valid sequences of JSON constructs and values.

		Methods (total 12)
			(*Encoder) Bytes() []byte
				Bytes returns the content of the written bytes.

			(*Encoder) EndArray()
				EndArray writes out the ']' symbol.

			(*Encoder) EndObject()
				EndObject writes out the '}' symbol.

			(*Encoder) StartArray()
				StartArray writes out the '[' symbol.

			(*Encoder) StartObject()
				StartObject writes out the '{' symbol.

			(*Encoder) WriteBool(b bool)
				WriteBool writes out the given boolean value.

			(*Encoder) WriteFloat(n float64, bitSize int)
				WriteFloat writes out the given float and bitSize in JSON number value.

			(*Encoder) WriteInt(n int64)
				WriteInt writes out the given signed integer in JSON number value.

			(*Encoder) WriteName(s string) error
				WriteName writes out the given string in JSON string value and the name
				separator ':'. Returns error if input string contains invalid UTF-8, which
				should not be likely as protobuf field names should be valid.

			(*Encoder) WriteNull()
				WriteNull writes out the null value.

			(*Encoder) WriteString(s string) error
				WriteString writes out the given string in JSON string value. Returns error
				if input string contains invalid UTF-8.

			(*Encoder) WriteUint(n uint64)
				WriteUint writes out the given unsigned integer in JSON number value.

		Implements (at least one exported)
			*Encoder : github.com/apache/arrow-go/v18/internal/hashing.ByteSlice
		As Outputs Of (at least one exported)
			func NewEncoder(buf []byte, indent string) (*Encoder, error)

	 type Kind uint16 (basic type)
		Kind represents a token kind expressible in the JSON format.

		Methods (only one)
			( Kind) String() string
		Implements (at least 2)
			 Kind : expvar.Var
			 Kind : fmt.Stringer
		As Outputs Of (at least one exported)
			func Token.Kind() Kind
		As Types Of (total 11)
			const ArrayClose
			const ArrayOpen
			const Bool
			const EOF
			const Invalid
			const Name
			const Null
			const Number
			const ObjectClose
			const ObjectOpen
			const String

	 type Token (struct)
		Token provides a parsed token kind and value.
		
		Values are provided by the difference accessor methods. The accessor methods
		Name, Bool, and ParsedString will panic if called on the wrong kind. There
		are different accessor methods for the Number kind for converting to the
		appropriate Go numeric type and those methods have the ok return value.

		Methods (total 9)
			( Token) Bool() bool
				Bool returns the bool value if token kind is Bool, else it panics.

			( Token) Float(bitSize int) (float64, bool)
				Float returns the floating-point number if token kind is Number.
				
				The floating-point precision is specified by the bitSize parameter: 32 for
				float32 or 64 for float64. If bitSize=32, the result still has type float64,
				but it will be convertible to float32 without changing its value. It will
				return false if the number exceeds the floating point limits for given
				bitSize.

			( Token) Int(bitSize int) (int64, bool)
				Int returns the signed integer number if token is Number.
				
				The given bitSize specifies the integer type that the result must fit into.
				It returns false if the number is not an integer value or if the result
				exceeds the limits for given bitSize.

			( Token) Kind() Kind
				Kind returns the token kind.

			( Token) Name() string
				Name returns the object name if token is Name, else it panics.

			( Token) ParsedString() string
				ParsedString returns the string value for a JSON string token or the read
				value in string if token is not a string.

			( Token) Pos() int
				Pos returns the token position from the input.

			( Token) RawString() string
				RawString returns the read value in string.

			( Token) Uint(bitSize int) (uint64, bool)
				Uint returns the signed integer number if token is Number.
				
				The given bitSize specifies the unsigned integer type that the result must
				fit into. It returns false if the number is not an unsigned integer value
				or if the result exceeds the limits for given bitSize.

		Implements (at least one exported)
			 Token : github.com/polarsignals/frostdb/query/logicalplan.Named
		As Outputs Of (at least 2)
			func (*Decoder).Peek() (Token, error)
			func (*Decoder).Read() (Token, error)
		As Inputs Of (at least one exported)
			func TokenEquals(x, y Token) bool


Package-Level Functions (total 3)

	 func NewDecoder(b []byte) *Decoder
		NewDecoder returns a Decoder to read the given []byte.

	 func NewEncoder(buf []byte, indent string) (*Encoder, error)
		NewEncoder returns an Encoder.
		
		If indent is a non-empty string, it causes every entry for an Array or Object
		to be preceded by the indent and trailed by a newline.

	 func TokenEquals(x, y Token) bool
		TokenEquals returns true if given Tokens are equal, else false.


Package-Level Variables (only one)

	  var ErrUnexpectedEOF error
		ErrUnexpectedEOF means that EOF was encountered in the middle of the input.


Package-Level Constants (total 11)

	const ArrayClose Kind = 512
	const ArrayOpen Kind = 256
	const Bool Kind = 4
	const EOF Kind = 1
	const Invalid Kind = 0
	const Name Kind = 32
	const Null Kind = 2
	const Number Kind = 8
	const ObjectClose Kind = 128
	const ObjectOpen Kind = 64
	const String Kind = 16

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.