package maps

Import Path
	internal/runtime/maps (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 2 packages

Involved Source Files

	    group.go
	  d map.go
		Package maps implements Go's builtin map type.

	    runtime.go
	    runtime_fast32_swiss.go
	    runtime_fast64_swiss.go
	    runtime_faststr_swiss.go
	    runtime_swiss.go
	  d table.go
		Package maps implements Go's builtin map type.

	  d table_debug.go
		Package maps implements Go's builtin map type.
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Iter (struct)

		Methods (total 6)
			(*Iter) Elem() unsafe.Pointer
				Key returns a pointer to the current element. nil indicates end of
				iteration.
				
				Must not be called prior to Next.

			(*Iter) Init(typ *abi.SwissMapType, m *Map)
				Init initializes Iter for iteration.

			(*Iter) Initialized() bool
			(*Iter) Key() unsafe.Pointer
				Key returns a pointer to the current key. nil indicates end of iteration.
				
				Must not be called prior to Next.

			(*Iter) Map() *Map
				Map returns the map this iterator is iterating over.

			(*Iter) Next()
				Next proceeds to the next element in iteration, which can be accessed via
				the Key and Elem methods.
				
				The table can be mutated during iteration, though there is no guarantee that
				the mutations will be visible to the iteration.
				
				Init must be called prior to Next.


	 type Map (struct)

		Methods (total 6)
			(*Map) Clear(typ *abi.SwissMapType)
				Clear deletes all entries from the map resulting in an empty map.

			(*Map) Delete(typ *abi.SwissMapType, key unsafe.Pointer)
			(*Map) Get(typ *abi.SwissMapType, key unsafe.Pointer) (unsafe.Pointer, bool)
				Get performs a lookup of the key that key points to. It returns a pointer to
				the element, or false if the key doesn't exist.

			(*Map) Put(typ *abi.SwissMapType, key, elem unsafe.Pointer)
			(*Map) PutSlot(typ *abi.SwissMapType, key unsafe.Pointer) unsafe.Pointer
				PutSlot returns a pointer to the element slot where an inserted element
				should be written.
				
				PutSlot never returns nil.

			(*Map) Used() uint64
		As Outputs Of (at least 3)
			func NewEmptyMap() *Map
			func NewMap(mt *abi.SwissMapType, hint uintptr, m *Map, maxAlloc uintptr) *Map
			func (*Iter).Map() *Map
		As Inputs Of (at least 2)
			func NewMap(mt *abi.SwissMapType, hint uintptr, m *Map, maxAlloc uintptr) *Map
			func (*Iter).Init(typ *abi.SwissMapType, m *Map)


Package-Level Functions (total 2)

	 func NewEmptyMap() *Map
	 func NewMap(mt *abi.SwissMapType, hint uintptr, m *Map, maxAlloc uintptr) *Map
		If m is non-nil, it should be used rather than allocating.
		
		maxAlloc should be runtime.maxAlloc.
		
		TODO(prattmic): Put maxAlloc somewhere accessible.

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