pacecache

package module

Go to main page

Versions in this module

v1

v1.3.0

Sep 19, 2026

Changes in this version

type Cache

+ func (cache *Cache[K, V]) StartCleanup()

+ func (cache *Cache[K, V]) StopCleanup()

type Metrics

+ Register func(source MetricsSource) error

+ type MetricsSource interface

+ Name func() string

+ Stats func() Stats

type Option

+ func WithName(name string) Option

v1.2.1

Sep 3, 2026

Changes in this version

type Cache

+ func (cache *Cache[K, V]) GetOrLoadEntryFunc(ctx context.Context, key K, loader Loader[K, V]) (Entry[V], bool, error)

+ func (cache *Cache[K, V]) GetOrLoadFunc(ctx context.Context, key K, loader Loader[K, V]) (V, bool, error)

v1.2.0

Sep 3, 2026

Changes in this version

+ var ErrNoLoader = errors.New("pacecache: loader is not configured")

+ var ErrNotInitialized = errors.New("pacecache: cache is not initialized")

type Cache

+ func NewWithDefaultLoader[K comparable, V any](name string, loader Loader[K, V], options ...Option) (*Cache[K, V], error)

+ func (cache *Cache[K, V]) Clear()

+ func (cache *Cache[K, V]) Delete(keys ...K)

+ func (cache *Cache[K, V]) DeleteExpired() int64

+ func (cache *Cache[K, V]) GetAndDelete(key K) (V, bool)

+ func (cache *Cache[K, V]) GetOrLoadEntryWith(ctx context.Context, key K, loader Loader[K, V]) (Entry[V], bool, error)

+ func (cache *Cache[K, V]) GetOrLoadWith(ctx context.Context, key K, loader Loader[K, V]) (V, bool, error)

type Stats

+ ClearedEntryCount int64

+ DeletedEntryCount int64

v1.1.0

Aug 28, 2026

v1.0.2

Aug 22, 2026

v1.0.1

Aug 21, 2026

v1.0.0

Aug 21, 2026

Changes in this version

+ const DefaultExpiration

+ const NoExpiration

+ var ErrLoadSuperseded = errors.New("pacecache: load superseded by cache mutation")

+ type Cache struct

+ func New[K comparable, V any](name string, options ...Option) (*Cache[K, V], error)

+ func (cache *Cache[K, V]) CleanupExpired() int64

+ func (cache *Cache[K, V]) Close()

+ func (cache *Cache[K, V]) Exists(key K) bool

+ func (cache *Cache[K, V]) Get(key K) (V, bool)

+ func (cache *Cache[K, V]) GetAndInvalidate(key K) (V, bool)

+ func (cache *Cache[K, V]) GetEntry(key K) (Entry[V], bool)

+ func (cache *Cache[K, V]) GetOrLoad(ctx context.Context, key K, loader Loader[V]) (V, bool, error)

+ func (cache *Cache[K, V]) GetOrLoadEntry(ctx context.Context, key K, loader Loader[V]) (Entry[V], bool, error)

+ func (cache *Cache[K, V]) GetOrSet(key K, value V, expiration time.Duration) (V, bool)

+ func (cache *Cache[K, V]) GetOrSetEntry(key K, value V, expiration time.Duration) (Entry[V], bool)

+ func (cache *Cache[K, V]) Invalidate(keys ...K)

+ func (cache *Cache[K, V]) InvalidateAll()

+ func (cache *Cache[K, V]) Name() string

+ func (cache *Cache[K, V]) RefreshTTL(key K) bool

+ func (cache *Cache[K, V]) Set(key K, value V, expiration time.Duration)

+ func (cache *Cache[K, V]) Stats() Stats

+ type Entry struct

+ func (entry Entry[V]) ExpiresAt() time.Time

+ func (entry Entry[V]) Value() V

+ type Loader func(ctx context.Context) (value V, found bool, err error)

+ type Metrics interface

+ RegisterCache func(cache StatsProvider) (MetricsRegistration, error)

+ type MetricsRegistration interface

+ Close func()

+ type Option func(*cacheSettings) error

+ func WithCleanupBatchSize(size int) Option

+ func WithCleanupEntryBudget(entries int) Option

+ func WithCleanupInterval(interval time.Duration) Option

+ func WithJitter(jitter time.Duration) Option

+ func WithMaxEntries(maxEntries int) Option

+ func WithMetrics(metrics Metrics) Option

+ func WithSegmentCount(count int) Option

+ func WithSlidingExpiration() Option

+ func WithTTL(ttl time.Duration) Option

+ type Stats struct

+ CleanupCount int64

+ CleanupWorkerDuration time.Duration

+ CleanupWorkerPendingCount int64

+ CleanupWorkerRunCount int64

+ EntryCount int64

+ EvictionCount int64

+ ExpirationCount int64

+ HitCount int64

+ InvalidatedAllCount int64

+ InvalidatedKeyCount int64

+ LoadDuration time.Duration

+ LoadErrorCount int64

+ LoadFoundCount int64

+ LoadNotFoundCount int64

+ LoadSupersededCount int64

+ MaxEntries int64

+ MissCount int64

+ SegmentCount int64

+ SharedCount int64

+ type StatsProvider interface

+ Name func() string

+ Stats func() Stats

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL