package intern

Import Path
	internal/intern (on go.dev)

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files

	  d intern.go
		Package intern lets you make smaller comparable values by boxing
		a larger comparable value (such as a 16 byte string header) down
		into a globally unique 8 byte pointer.
		
		The globally unique pointers are garbage collected with weak
		references and finalizers. This package hides that.
Package-Level Type Names (total 2, in which 1 is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Value (struct)
		A Value pointer is the handle to an underlying comparable value.
		See func Get for how Value pointers may be used.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			cmpVal any
			resurrected bool
				resurrected is guarded by mu (for all instances of Value).
				It is set true whenever v is synthesized from a uintptr.

		Methods (only one, which is exported)
			(*Value) Get() any
				Get returns the comparable value passed to the Get func
				that returned v.

		As Outputs Of (at least 4, in which 2 are exported)
			func Get(cmpVal any) *Value
			func GetByString(s string) *Value
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func get(k key) *Value
			func safeMap() map[key]*Value
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func finalize(v *Value)
		As Types Of (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			  var net/netip.z0 *Value
			  var net/netip.z4 *Value
			  var net/netip.z6noz *Value

	/* one unexported ... *//* one unexported: */
	 type key (struct)
		key is a key in our global value map.
		It contains type-specialized fields to avoid allocations
		when converting common types to empty interfaces.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			cmpVal any
			isString bool
				isString reports whether key contains a string.
				Without it, the zero value of key is ambiguous.

			s string
		Methods (only one, which is exported)
			( key) Value() *Value
				Value returns a *Value built from k.

		As Outputs Of (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func keyFor(cmpVal any) key
			func safeMap() map[key]*Value
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func get(k key) *Value


Package-Level Functions (total 6, in which 2 are exported)

	 func Get(cmpVal any) *Value
		Get returns a pointer representing the comparable value cmpVal.
		
		The returned pointer will be the same for Get(v) and Get(v2)
		if and only if v == v2, and can be used as a map key.

	 func GetByString(s string) *Value
		GetByString is identical to Get, except that it is specialized for strings.
		This avoids an allocation from putting a string into an interface{}
		to pass as an argument to Get.

	/* 4 unexporteds ... *//* 4 unexporteds: */
	 func finalize(v *Value)
	 func get(k key) *Value
		We play unsafe games that violate Go's rules (and assume a non-moving
		collector). So we quiet Go here.
		See the comment below Get for more implementation details.

	 func keyFor(cmpVal any) key
		keyFor returns a key to use with cmpVal.

	 func safeMap() map[key]*Value
		safeMap returns a non-nil map if we're in safe-but-leaky mode,
		as controlled by GODEBUG=intern=leaky


Package-Level Variables (total 4, none are exported)

	/* 4 unexporteds ... *//* 4 unexporteds: */
	  var intern *godebug.Setting
	  var mu sync.Mutex
		mu guards valMap, a weakref map of *Value by underlying value.
		It also guards the resurrected field of all *Values.

	  var valMap map[key]uintptr // to uintptr(*Value)
	  var valSafe map[key]*Value // non-nil in safe+leaky mode

The pages are generated with Golds v0.6.7. (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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.