go_tools

type Cache[T any] interface {
	// Get returns the object stored in the cache with the given key.
	// If the object has expired, it will be removed from the cache and nil will be returned.
	Get(key string) CacheObject[T]
	Set(key string, obj T)
	Clear()
}

type CacheObject[T any] interface {
	Get() T
	Expired() bool
	Insert() time.Time
}

type MutablePair[L, R any] interface {
	Pair[L, R]
	SetLeft(L)
	SetRight(R)
}

type Pair[L, R any] interface {
	Left() L
	Right() R
}

type Queue[T comparable] interface {
	Enqueue(item T)
	Dequeue() (*T, error)
	IsEmpty() bool
	Size() int
	Items() []T
	RemoveFunc(func(T) bool) bool
}

type SafeDoubleMap[K, V comparable] interface {
	SafeMap[K, V]
	RemoveByValue(V)
}

type SafeMap[K comparable, V any] interface {
	Get(K) (V, bool)
	Put(K, V)
	Remove(K)

	Contains(K) bool
	Keys() []K
	Values() []V
	Size() int
	Copy() map[K]V

	// ForEach iterates over the map and calls the given function for each key-value pair.
	// The order of iteration is not guaranteed. If the function returns false, the iteration stops.
	//
	// As the map is read-locked during the iteration, the function should not call any method that modifies the map.
	ForEach(func(K, V) bool)
}