cache

package module

v0.0.0-...-49b3bd4 Latest Latest Go to latest Published: May 8, 2024 License: MIT Imports: 3 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type CacheMap[K goutil.Hashable, V any] struct {
	// contains filtered or unexported fields
}

func NewCache[K goutil.Hashable, V any](exp time.Duration) *CacheMap[K, V]

NewCache creates a new cache map

func NewCacheCB[K goutil.Hashable, V any](exp time.Duration) (*CacheMap[K, V], func())

NewCacheCB is just like the NewCache method, but it returns the loop in a callback function, to avoid creating more goroutines

func (cache *CacheMap[K, V]) Del(key K)

Del removes a cache item by key

func (cache *CacheMap[K, V]) DelOld(cacheTime time.Duration)

DelOld removes old cache items

func (cache *CacheMap[K, V]) Expire(exp time.Duration) bool

Expire sets the ttl for all cache items

func (cache *CacheMap[K, V]) ForEach(cb func(key K, value V) bool, touch ...bool)

ForEach runs a callback function for each cache item that has not expired

in the callback, return true to continue, and false to break the loop

func (cache *CacheMap[K, V]) Get(key K) (V, error)

Get returns a value or an error if it exists

if the object key does not exist, it will return both a nil/zero value (of the relevant type) and nil error

func (cache *CacheMap[K, V]) Has(key K) bool

Has returns true if a key value exists and is not an error

func (cache *CacheMap[K, V]) Set(key K, value V, err error)

Set sets or adds a new key with either a value, or an error

func (cache *CacheMap[K, V]) Touch(key K) bool

Touch resets a cache items expiration so it will stay in the cache longer