maps

Documentation

Overview

Package maps provides utilities to manipulate maps.

Index

• func Keys[M ~map[K]V, K comparable, V any](m M) []K
• func Merge[M ~map[K]V, K comparable, V any](m ...M) M
• func Values[M ~map[K]V, K comparable, V any](m M) []V
• type SyncMap
  • func (m *SyncMap[K, V]) Delete(key K)
  • func (m *SyncMap[K, V]) IsEmpty() bool
  • func (m *SyncMap[K, V]) Keys() []K
  • func (m *SyncMap[K, V]) Load(key K) (value V, ok bool)
  • func (m *SyncMap[K, V]) LoadAndDelete(key K) (value V, loaded bool)
  • func (m *SyncMap[K, V]) LoadOrStore(key K, value V) (V, bool)
  • func (m *SyncMap[K, V]) Range(f func(key K, value V) bool)
  • func (m *SyncMap[K, V]) Size() int
  • func (m *SyncMap[K, V]) Store(key K, value V)
  • func (m *SyncMap[K, V]) Swap(key K, value V) (V, bool)
  • func (m *SyncMap[K, V]) Values() []V

Functions

func Keys

func Keys[M ~map[K]V, K comparable, V any](m M) []K

Keys returns the keys of the map m. The keys will be in an indeterminate order.

func Merge

func Merge[M ~map[K]V, K comparable, V any](m ...M) M

Merge merges the maps in m into a single map. If a key is present in multiple maps, the value from the last map will be used.

func Values

func Values[M ~map[K]V, K comparable, V any](m M) []V

Values returns the values of the map m. The values will be in an indeterminate order.

Types

type SyncMap

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

SyncMap is a wrapper around sync.Map that provides a few additional methods.

func (*SyncMap[K, V]) Delete

func (m *SyncMap[K, V]) Delete(key K)

Delete deletes the value for a key.

func (*SyncMap[K, V]) IsEmpty

func (m *SyncMap[K, V]) IsEmpty() bool

IsEmpty returns true if the map is empty.

func (*SyncMap[K, V]) Keys

func (m *SyncMap[K, V]) Keys() []K

Keys returns all the keys in the map.

func (*SyncMap[K, V]) Load

func (m *SyncMap[K, V]) Load(key K) (value V, ok bool)

Load returns the value stored in the map for a key, or nil if no value is present.

func (*SyncMap[K, V]) LoadAndDelete

func (m *SyncMap[K, V]) LoadAndDelete(key K) (value V, loaded bool)

LoadAndDelete deletes the value for a key, returning the previous value if any.

func (*SyncMap[K, V]) LoadOrStore

func (m *SyncMap[K, V]) LoadOrStore(key K, value V) (V, bool)

LoadOrStore returns the existing value for the key if present.

func (*SyncMap[K, V]) Range

func (m *SyncMap[K, V]) Range(f func(key K, value V) bool)

Range calls f sequentially for each key and value present in the map.

func (*SyncMap[K, V]) Size

func (m *SyncMap[K, V]) Size() int

Size returns the number of items in the map.

func (*SyncMap[K, V]) Store

func (m *SyncMap[K, V]) Store(key K, value V)

Store sets the value for a key.

func (*SyncMap[K, V]) Swap

func (m *SyncMap[K, V]) Swap(key K, value V) (V, bool)

Swap stores value for key and returns the previous value for that key.

func (*SyncMap[K, V]) Values

func (m *SyncMap[K, V]) Values() []V

Values returns all the values in the map.