timedcache

type CacheItems map[any]Item

type Config struct {
	ExpirationTime  int       `json:"expiration_time"`
	OnEvicted       OnEvictFn `config_hide:"true"     json:"-"`
	CacheHitMetric  MetricFn  `config_hide:"true"     json:"-"`
	CacheMissMetric MetricFn  `config_hide:"true"     json:"-"`
	CacheGetMetric  MetricFn  `config_hide:"true"     json:"-"`
	CacheSetMetric  MetricFn  `config_hide:"true"     json:"-"`
}

type Item struct {
	Object any
}

type MetricFn func()

type OnEvictFn func(any, any)

type TimedCache interface {
	// Sets the value for the given key to the given value.
	//
	// This uses Go map semantics, so if the given key doesn't exist in
	// the cache then one will be created.
	Set(any, any)

	// Gets the value for the given key.
	//
	// If the key exists, then the value and `true` will be returned;
	// otherwise `nil` and `false` will be returned.
	Get(any) (any, bool)

	// Adds the given key/value pair to the cache.
	//
	// This method expects the given key to not be present in the cache
	// and will return `ErrKeyExists` should it be present.
	Add(any, any) error

	// Replace the value for the given key with the given value.
	//
	// This method expects the given key to be present in the cache and
	// will return `ErrKeyNotExist` should it not be present.
	Replace(any, any) error

	// Delete the key/value pair from the cache.
	//
	// If the key exists, then its value and `true` will be returned;
	// otherwise `nil` and `false` will be returned.
	//
	// This method will attempt to invoke the "on eviction" callback.
	Delete(any) (any, bool)

	// Sets the "on eviction" callback to the given function.
	//
	// The function should take two arguments, the key and the value, of
	// type `any` and should not return a value.
	OnEvicted(OnEvictFn)

	// Return a count of the number of items in the cache.
	Count() int

	// Flush all items from the cache.
	Flush()

	// Return the time the cache was last updated.
	LastUpdated() time.Time

	//  Returns `true` if the cache has expired.
	Expired() bool

	// Return a list of all keys in the cache.
	Keys() []any
}