collections

Documentation

Index

• func GetOrDefault[K comparable, V any](m map[K]V, key K, defaultValue V) V
• func MapSlice[K any, V any](base []K, mapper func(K) V) []V
• func MergeMaps[K comparable, V any](maps ...map[K]V) map[K]V
• func WithNewKeys[K comparable, V any](base map[K]V, keyMapper map[K]K) map[K]V
• type Pair
  • func NewPair[K any, V any](key K, value V) *Pair[K, V]
• type Set
  • func NewSet[K comparable](keys ...K) Set[K]
  • func (s Set[K]) Add(keys ...K)
  • func (s Set[K]) Contains(key K) bool
  • func (s Set[K]) Remove(key K)

Functions

func GetOrDefault

func GetOrDefault[K comparable, V any](m map[K]V, key K, defaultValue V) V

GetOrDefault retrieves the value for the key in the map if it exists. If it doesn't exist, then returns the default value.

func MapSlice

func MapSlice[K any, V any](base []K, mapper func(K) V) []V

MapSlice converts a slice of type K into a slice of type V using the provided mapper function.

func MergeMaps

func MergeMaps[K comparable, V any](maps ...map[K]V) map[K]V

MergeMaps merges multiple maps into a new one. Duplicate keys will take the last map's value.

func WithNewKeys

func WithNewKeys[K comparable, V any](base map[K]V, keyMapper map[K]K) map[K]V

WithNewKeys re-maps every key in a map as dictated by the mapper. If the key does not have an entry in the mapper, it is left untouched.

Types

type Pair

type Pair[K any, V any] struct {
	Key   K
	Value V
}

Pair is a struct with a K key and V value.

func NewPair

func NewPair[K any, V any](key K, value V) *Pair[K, V]

NewPair creates a new Pair with key and value.

type Set

type Set[K comparable] map[K]any

Set is a map with a comparable K key and no meaningful value.

func NewSet

func NewSet[K comparable](keys ...K) Set[K]

NewSet creates a new Set with the keys provided.

func (Set[K]) Add

func (s Set[K]) Add(keys ...K)

Add keys to the Set.

func (Set[K]) Contains

func (s Set[K]) Contains(key K) bool

Contains whether the key is in the Set.

func (Set[K]) Remove

func (s Set[K]) Remove(key K)

Remove a key from the Set.