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, both are exported)

	/* sort exporteds 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, which is exported)
			( Bools) JSONOptions(internal.NotForPublicUse)
		Implements (at least one exported)
			 Bools : encoding/json/internal/jsonopts.Options
		As Inputs Of (at least 4, all are exported)
			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 57, in which 53 are exported)
			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 EscapeForHTML
			const EscapeForJS
			const FormatByteArrayAsArray
			const FormatBytesWithLegacySemantics
			const FormatDurationAsNano
			const FormatNilMapAsNull
			const FormatNilSliceAsNull
			const FormatTag
			const FormatTagSupported
			const Indent
			const IndentPrefix
			const Marshalers
			const MatchCaseInsensitiveNames
			const MatchCaseSensitiveDelimiter
			const MergeWithLegacySemantics
			const Multiline
			const NonBooleanFlags
			const OmitEmptyWithLegacySemantics
			const OmitTopLevelNewline
			const OmitZeroStructFields
			const ParseBytesWithLooseRFC4648
			const ParseTimeWithLooseRFC3339
			const PreserveRawStrings
			const RejectUnknownMembers
			const ReorderRawObjects
			const ReportErrorsWithLegacySemantics
			const SpaceAfterColon
			const SpaceAfterComma
			const StringifyNumbers
			const StringifyWithLegacySemantics
			const StringTag
			const TagFlags
			const UnmarshalAnyWithRawNumber
			const UnmarshalArrayFromAnyLength
			const Unmarshalers
			const WhitespaceFlags
			const WithinArshalCall
			/* 4 unexporteds ... *//* 4 unexporteds: */
			const initFlag
			const maxArshalV1Flag
			const maxArshalV2Flag
			const maxCoderFlag

	 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, both are exported)
			Presence uint64
			Values uint64
		Methods (total 5, all are exported)
			(*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 7, in which 4 are exported)
			func (*Flags).Join(src Flags)
			func encoding/json/internal/jsonwire.AppendQuote(dst, src []byte, 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)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func encoding/json/jsontext.Token.appendNumber(dst []byte, flags *Flags) ([]byte, error)
			func encoding/json/jsontext.Token.appendString(dst []byte, flags *Flags) ([]byte, error)
			func encoding/json/v2.isFatalError(err error, flags Flags) bool


Package-Level Constants (total 58, in which 53 are exported)

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

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

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

	const AllFlags Bools = 8796093022206
		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 = 1536
		AnyEscape is the set of flags related to escaping in a JSON string.

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

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

	const CallMethodsWithLegacySemantics Bools = 1073741824 // 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 = 6596008085030
		DefaultV1Flags is the set of boolean flags that default to true under
		v1 semantics. None of the non-boolean flags differ between v1 and v2.

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

	const Deterministic Bools = 524288 // 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 FormatByteArrayAsArray Bools = 2147483648 // marshal or unmarshal
		Marshal and Unmarshal flags (for v1).

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

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

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

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

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

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

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

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

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

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

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

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

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

	const NonBooleanFlags Bools = 369344512
		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 OmitEmptyWithLegacySemantics Bools = 68719476736 // 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 = 4194304 // marshal only
		Marshal and Unmarshal flags (for v2).

	const ParseBytesWithLooseRFC4648 Bools = 137438953472 // unmarshal
		Marshal and Unmarshal flags (for v1).

	const ParseTimeWithLooseRFC3339 Bools = 274877906944 // unmarshal
		Marshal and Unmarshal flags (for v1).

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

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

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

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

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

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

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

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

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

	const TagFlags Bools = 402653184
		TagFlags is the set of flags related to the presence of struct field tags.
		Tags have non-recursive effects, where the tag only applies to
		the top-level of the field value itself.
		Whenever descending into a JSON object or array, these flags are cleared.

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

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

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

	const WhitespaceFlags Bools = 63488
		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.

	/* 5 unexporteds ... *//* 5 unexporteds: */
	const bitsUsed = 43
		bitsUsed is the number of bits used in the 64-bit boolean flags

	const initFlag Bools = 1 // reserved for the boolean value itself
		Encoder and decoder flags.

	const maxArshalV1Flag Bools = 8796093022208
		Marshal and Unmarshal flags (for v1).

	const maxArshalV2Flag Bools = 1073741824
		Marshal and Unmarshal flags (for v2).

	const maxCoderFlag Bools = 262144
		Encoder and decoder flags.

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