cache

package

v0.3.2 Latest Latest Go to latest Published: Sep 15, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Package cache contains cache utilities and implementations

This section is empty.

This section is empty.

This section is empty.

type Cacher[T any] interface {
	Get(key string) (T, bool)
	Set(key string, value T)
}

Cacher is the interface for the cache. It provides methods to get and set

type Expiring[T any] interface {
	Expiration() time.Time
	Value() T
}

Expiring is an interface for an expiring cache entry It provides a method to get the expiration time and the value

func NewExpiring[T any](value T, expiration time.Time) Expiring[T]

NewExpiring creates a new Expiring entry

type ExpiringCache[T any] struct {
	// contains filtered or unexported fields
}

ExpiringCache is a cache that expires entries after a certain time

func NewExpiringCache[T any](ctx context.Context, cfg *ExpiringCacheConfig) *ExpiringCache[T]

NewExpiringCache creates a new ExpiringCache based on the configuration If the configuration is nil, the default eviction time is 30 minutes

func (ec *ExpiringCache[T]) Close()

Close stops the eviction routine and disallows setting new entries

func (ec *ExpiringCache[T]) Delete(key string)

Delete deletes the entry from the cache

func (ec *ExpiringCache[T]) Get(key string) (T, bool)

Get returns the value of the entry and a boolean indicating if the entry exists

func (ec *ExpiringCache[T]) Set(key string, value T)

Set sets the value of the entry

func (ec *ExpiringCache[T]) Size() int

Size returns the number of entries in the cache. This is useful for testing purposes

type ExpiringCacheConfig struct {
	EvictionTime time.Duration
}

ExpiringCacheConfig is the configuration for the ExpiringCache