simplelru

type EvictCallback[Key, Value any] func(key Key, value Value)

type LRU[Key comparable, Value any] struct {
	// contains filtered or unexported fields
}

type LRUCache[Key, Value any] interface {
	// Adds a value to the cache, returns true if an eviction occurred and
	// updates the "recently used"-ness of the key.
	Add(key Key, value Value) bool

	// Returns key's value from the cache and
	// updates the "recently used"-ness of the key. #value, isFound
	Get(key Key) (value Value, ok bool)

	// Checks if a key exists in cache without updating the recent-ness.
	Contains(key Key) (ok bool)

	// Returns key's value without updating the "recently used"-ness of the key.
	Peek(key Key) (value Value, ok bool)

	// Removes a key from the cache.
	Remove(key Key) bool

	// Removes the oldest entry from cache.
	RemoveOldest() (Key, Value, bool)

	// Returns the oldest entry from the cache. #key, value, isFound
	GetOldest() (Key, Value, bool)

	// Returns a slice of the keys in the cache, from oldest to newest.
	Keys() []Key

	// Returns the number of items in the cache.
	Len() int

	// Clears all cache entries.
	Purge()

	// Resizes cache, returning number evicted
	Resize(int) int
}