package jsonflags

Import Path
	encoding/json/internal/jsonflags (on go.dev)

Dependency Relation
	imports one package, and imported by 5 packages

Involved Source Files

	  d flags.go
		jsonflags implements all the optional boolean flags.
		These flags are shared across both "json", "jsontext", and "jsonopts".
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Bools uint64 (basic type)
		Bools represents zero or more boolean flags, all set to true or false.
		The least-significant bit is the boolean value of all flags in the set.
		The remaining bits identify which particular flags.
		
		In common usage, this is OR'd with 0 or 1. For example:
		  - (AllowInvalidUTF8 | 0) means "AllowInvalidUTF8 is false"
		  - (Multiline | Indent | 1) means "Multiline and Indent are true"

		Methods (only one)
			( Bools) JSONOptions(internal.NotForPublicUse)
		Implements (at least one exported)
			 Bools : encoding/json/internal/jsonopts.Options
		As Inputs Of (at least 4)
			func (*Flags).Clear(f Bools)
			func Flags.Get(f Bools) bool
			func Flags.Has(f Bools) bool
			func (*Flags).Set(f Bools)
		As Types Of (total 49)
			const AllArshalV1Flags
			const AllArshalV2Flags
			const AllCoderFlags
			const AllFlags
			const AllowDuplicateNames
			const AllowInvalidUTF8
			const AnyEscape
			const AnyWhitespace
			const ByteLimit
			const CallMethodsWithLegacySemantics
			const CanonicalizeNumbers
			const CanonicalizeRawFloats
			const CanonicalizeRawInts
			const DefaultV1Flags
			const DepthLimit
			const Deterministic
			const DiscardUnknownMembers
			const EscapeForHTML
			const EscapeForJS
			const EscapeInvalidUTF8
			const FormatBytesWithLegacySemantics
			const FormatNilMapAsNull
			const FormatNilSliceAsNull
			const FormatTimeWithLegacySemantics
			const Indent
			const IndentPrefix
			const Marshalers
			const MatchCaseInsensitiveNames
			const MatchCaseSensitiveDelimiter
			const MergeWithLegacySemantics
			const Multiline
			const NonBooleanFlags
			const OmitEmptyWithLegacyDefinition
			const OmitTopLevelNewline
			const OmitZeroStructFields
			const PreserveRawStrings
			const RejectUnknownMembers
			const ReorderRawObjects
			const ReportErrorsWithLegacySemantics
			const SpaceAfterColon
			const SpaceAfterComma
			const StringifyBoolsAndStrings
			const StringifyNumbers
			const StringifyWithLegacySemantics
			const UnmarshalAnyWithRawNumber
			const UnmarshalArrayFromAnyLength
			const Unmarshalers
			const WhitespaceFlags
			const WithinArshalCall

	 type Flags (struct)
		Flags is a set of boolean flags.
		If the presence bit is zero, then the value bit must also be zero.
		The least-significant bit of both fields is always zero.
		
		Unlike Bools, which can represent a set of bools that are all true or false,
		Flags represents a set of bools, each individually may be true or false.

		Fields (total 2)
			Presence uint64
			Values uint64
		Methods (total 5)
			(*Flags) Clear(f Bools)
				Clear clears both the presence and value for the provided bool or bools.
				The value bit of f (i.e., the LSB) is ignored.

			( Flags) Get(f Bools) bool
				Get reports whether the bool (or any of the bools) is true.
				This is generally only used with a singular bool.
				The value bit of f (i.e., the LSB) is ignored.

			( Flags) Has(f Bools) bool
				Has reports whether the bool (or any of the bools) is set.
				The value bit of f (i.e., the LSB) is ignored.

			(*Flags) Join(src Flags)
				Join joins two sets of flags such that the latter takes precedence.

			(*Flags) Set(f Bools)
				Set sets both the presence and value for the provided bool (or set of bools).

		As Inputs Of (at least 4)
			func (*Flags).Join(src Flags)
			func encoding/json/internal/jsonwire.AppendQuote[Bytes](dst []byte, src Bytes, flags *Flags) ([]byte, error)
			func encoding/json/internal/jsonwire.ReformatNumber(dst, src []byte, flags *Flags) ([]byte, int, error)
			func encoding/json/internal/jsonwire.ReformatString(dst, src []byte, flags *Flags) ([]byte, int, error)


Package-Level Constants (total 49)

	const AllArshalV1Flags Bools = 1098974756864
		AllArshalV1Flags is the set of all v1 marshal/unmarshal flags.

	const AllArshalV2Flags Bools = 536346624
		AllArshalV2Flags is the set of all v2 marshal/unmarshal flags.

	const AllCoderFlags Bools = 524286
		AllCoderFlags is the set of all encoder/decoder flags.

	const AllFlags Bools = 1099511627774
		AllFlags is the set of all flags.

	const AllowDuplicateNames Bools = 2 // encode or decode
		Encoder and decoder flags.

	const AllowInvalidUTF8 Bools = 4 // encode or decode
		Encoder and decoder flags.

	const AnyEscape Bools = 3584
		AnyEscape is the set of flags related to escaping in a JSON string.

	const AnyWhitespace Bools = 28672
		AnyWhitespace reports whether the encoded output might have any whitespace.

	const ByteLimit Bools = 131072 // encode or decode; non-boolean flag
		Encoder and decoder flags.

	const CallMethodsWithLegacySemantics Bools = 536870912 // marshal or unmarshal
		Marshal and Unmarshal flags (for v1).

	const CanonicalizeNumbers Bools = 192
		CanonicalizeNumbers is the set of flags related to raw number canonicalization.

	const CanonicalizeRawFloats Bools = 128 // encode only
		Encoder and decoder flags.

	const CanonicalizeRawInts Bools = 64 // encode only
		Encoder and decoder flags.

	const DefaultV1Flags Bools = 686682017318
		DefaultV1Flags is the set of booleans flags that default to true under
		v1 semantics. None of the non-boolean flags differ between v1 and v2.

	const DepthLimit Bools = 262144 // encode or decode; non-boolean flag
		Encoder and decoder flags.

	const Deterministic Bools = 1048576 // marshal only
		Marshal and Unmarshal flags (for v2).

	const DiscardUnknownMembers Bools = 33554432 // marshal only
		Marshal and Unmarshal flags (for v2).

	const EscapeForHTML Bools = 512 // encode only
		Encoder and decoder flags.

	const EscapeForJS Bools = 1024 // encode only
		Encoder and decoder flags.

	const EscapeInvalidUTF8 Bools = 2048 // encode only; only exposed in v1
		Encoder and decoder flags.

	const FormatBytesWithLegacySemantics Bools = 1073741824 // marshal or unmarshal
		Marshal and Unmarshal flags (for v1).

	const FormatNilMapAsNull Bools = 2097152 // marshal only
		Marshal and Unmarshal flags (for v2).

	const FormatNilSliceAsNull Bools = 4194304 // marshal only
		Marshal and Unmarshal flags (for v2).

	const FormatTimeWithLegacySemantics Bools = 2147483648 // marshal or unmarshal
		Marshal and Unmarshal flags (for v1).

	const Indent Bools = 32768 // encode only; non-boolean flag
		Encoder and decoder flags.

	const IndentPrefix Bools = 65536 // encode only; non-boolean flag
		Encoder and decoder flags.

	const Marshalers Bools = 134217728 // marshal only; non-boolean flag
		Marshal and Unmarshal flags (for v2).

	const MatchCaseInsensitiveNames Bools = 16777216 // marshal or unmarshal
		Marshal and Unmarshal flags (for v2).

	const MatchCaseSensitiveDelimiter Bools = 4294967296 // marshal or unmarshal
		Marshal and Unmarshal flags (for v1).

	const MergeWithLegacySemantics Bools = 8589934592 // unmarshal
		Marshal and Unmarshal flags (for v1).

	const Multiline Bools = 4096 // encode only
		Encoder and decoder flags.

	const NonBooleanFlags Bools = 403144704
		NonBooleanFlags is the set of non-boolean flags,
		where the value is some other concrete Go type.
		The value of the flag is stored within jsonopts.Struct.

	const OmitEmptyWithLegacyDefinition Bools = 17179869184 // marshal
		Marshal and Unmarshal flags (for v1).

	const OmitTopLevelNewline Bools = 16 // encode only; for internal use by json.Marshal and json.MarshalWrite
		Encoder and decoder flags.

	const OmitZeroStructFields Bools = 8388608 // marshal only
		Marshal and Unmarshal flags (for v2).

	const PreserveRawStrings Bools = 32 // encode only
		Encoder and decoder flags.

	const RejectUnknownMembers Bools = 67108864 // unmarshal only
		Marshal and Unmarshal flags (for v2).

	const ReorderRawObjects Bools = 256 // encode only
		Encoder and decoder flags.

	const ReportErrorsWithLegacySemantics Bools = 34359738368 // marshal or unmarshal
		Marshal and Unmarshal flags (for v1).

	const SpaceAfterColon Bools = 8192 // encode only
		Encoder and decoder flags.

	const SpaceAfterComma Bools = 16384 // encode only
		Encoder and decoder flags.

	const StringifyBoolsAndStrings Bools = 137438953472 // marshal or unmarshal; for internal use by jsonv2.makeStructArshaler
		Marshal and Unmarshal flags (for v1).

	const StringifyNumbers Bools = 524288 // marshal or unmarshal
		Marshal and Unmarshal flags (for v2).

	const StringifyWithLegacySemantics Bools = 68719476736 // marshal or unmarshal
		Marshal and Unmarshal flags (for v1).

	const UnmarshalAnyWithRawNumber Bools = 274877906944 // unmarshal; for internal use by jsonv1.Decoder.UseNumber
		Marshal and Unmarshal flags (for v1).

	const UnmarshalArrayFromAnyLength Bools = 549755813888 // unmarshal
		Marshal and Unmarshal flags (for v1).

	const Unmarshalers Bools = 268435456 // unmarshal only; non-boolean flag
		Marshal and Unmarshal flags (for v2).

	const WhitespaceFlags Bools = 126976
		WhitespaceFlags is the set of flags related to whitespace formatting.
		In contrast to AnyWhitespace, this includes Indent and IndentPrefix
		as those settings take no effect if Multiline is false.

	const WithinArshalCall Bools = 8 // encode or decode; for internal use by json.Marshal and json.Unmarshal
		Encoder and decoder flags.

The pages are generated with Golds v0.7.7-preview. (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.