lnutils

README

lnutils

This package provides fundamental types and utility functions that can be used by all other packages.

Documentation

Index

• func Map[T1, T2 any](s []T1, f func(T1) T2) []T2
• func RecvOrTimeout[T any](c <-chan T, timeout time.Duration) (*T, error)
• type SyncMap
  • func (m *SyncMap[K, V]) Delete(key K)
  • func (m *SyncMap[K, V]) Load(key K) (V, bool)
  • func (m *SyncMap[K, V]) LoadAndDelete(key K) (V, bool)
  • func (m *SyncMap[K, V]) Range(visitor func(K, V) bool)
  • func (m *SyncMap[K, V]) Store(key K, value V)

Functions

func Map

func Map[T1, T2 any](s []T1, f func(T1) T2) []T2

Map takes an input slice, and applies the function f to each element, yielding a new slice.

func RecvOrTimeout

func RecvOrTimeout[T any](c <-chan T, timeout time.Duration) (*T, error)

RecvOrTimeout attempts to recv over chan c, returning the value. If the timeout passes before the recv succeeds, an error is returned.

Types

type SyncMap

type SyncMap[K comparable, V any] struct {
	sync.Map
}

SyncMap wraps a sync.Map with type parameters such that it's easier to access the items stored in the map since no type assertion is needed. It also requires explicit type definition when declaring and initiating the variables, which helps us understanding what's stored in a given map.

func (*SyncMap[K, V]) Delete

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

Delete removes an item from the map specified by the key.

func (*SyncMap[K, V]) Load

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

Load queries an item from the map using the specified key. If the item cannot be found, an empty value and false will be returned. If the stored item fails the type assertion, a nil value and false will be returned.

func (*SyncMap[K, V]) LoadAndDelete

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

LoadAndDelete queries an item and deletes it from the map using the specified key.

func (*SyncMap[K, V]) Range

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

Range iterates the map.

func (*SyncMap[K, V]) Store

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

Store puts an item in the map.