immutable

package

v0.15.3 Latest Latest Go to latest Published: Apr 12, 2024 License: BSD-3-Clause Imports: 0 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

cs.opensource.google/go/x/tools

Links

Documentation ¶

Overview ¶

The immutable package defines immutable wrappers around common data structures. These are used for additional type safety inside gopls.

See the "persistent" package for copy-on-write data structures.

Index ¶

type Map
- func MapOf[K comparable, V any](m map[K]V) Map[K, V]

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Map ¶

type Map[K comparable, V any] struct {
	// contains filtered or unexported fields
}

Map is an immutable wrapper around an ordinary Go map.

func MapOf ¶

func MapOf[K comparable, V any](m map[K]V) Map[K, V]

MapOf wraps the given Go map.

The caller must not subsequently mutate the map.

func (Map[K, V]) Len ¶

func (m Map[K, V]) Len() int

Len returns the number of entries in the Map.

func (Map[K, V]) Range ¶

func (m Map[K, V]) Range(f func(k K, v V))

Range calls f for each mapped (key, value) pair. There is no way to break out of the loop. TODO: generalize when Go iterators (#61405) land.

func (Map[K, V]) Value ¶

func (m Map[K, V]) Value(k K) (V, bool)

Value returns the mapped value for k. It is equivalent to the commaok form of an ordinary go map, and returns (zero, false) if the key is not present.

Source Files ¶

View all Source files

immutable.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL