Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

gocache

package module

Go to main page

Versions in this module

v0

v0.3.1

Aug 12, 2026

v0.3.0

Aug 12, 2026

Changes in this version

type Observation

+ Capacity int

+ Count int

+ Occupancy int

type Operation

+ const OperationEvict

v0.2.1

Aug 5, 2026

v0.2.0

Aug 5, 2026

Changes in this version

+ var ErrInvalidSingleflightValue = errors.New("gocache: invalid singleflight value type")

+ var ErrInvalidStringKeyType = errors.New("gocache: key is not string-compatible")

+ var ErrKeyEncoderRequired = errors.New("gocache: key encoder required for non-string key type")

+ var ErrLogicalPrefixUnsupported = errors.New("gocache: logical prefix invalidation unsupported for non-string key type")

+ var ErrNilFetch = errors.New("gocache: nil fetch function")

+ var ErrNilKeyEncoderFunc = errors.New("gocache: nil key encoder func")

+ func EncodeStorageKey[K comparable](key K, encoder KeyEncoder[K]) (string, error)

+ func GetOrFetchWithOptions[K comparable, V any](ctx context.Context, cache Cache[K, V], key K, opts GetOrFetchOptions, ...) (V, error)

+ func GetOrFetch[K comparable, V any](ctx context.Context, cache Cache[K, V], key K, ttl time.Duration, ...) (V, error)

+ func Observe(ctx context.Context, observer Observer, event Observation)

+ type BatchInvalidator interface

+ InvalidateKeys func(ctx context.Context, keys []K) error

+ type Cache interface

+ Delete func(ctx context.Context, key K) error

+ Get func(ctx context.Context, key K) (V, bool, error)

+ Set func(ctx context.Context, key K, value V, ttl time.Duration) error

+ type Clearable interface

+ Clear func(ctx context.Context) error

+ type GetOrFetchOptions struct

+ Group SingleflightGroup

+ GroupKey string

+ ReadErrorMode ReadErrorMode

+ TTL time.Duration

+ WriteErrorMode WriteErrorMode

+ type KeyEncoder interface

+ EncodeKey func(K) (string, error)

+ func NewStringKeyEncoder[K ~string]() KeyEncoder[K]

+ func ResolveKeyEncoder[K comparable](encoder KeyEncoder[K]) (KeyEncoder[K], error)

+ type KeyEncoderFunc func(K) (string, error)

+ func (f KeyEncoderFunc[K]) EncodeKey(key K) (string, error)

+ type Observation struct

+ Backend string

+ Err error

+ Key string

+ Latency time.Duration

+ Operation Operation

+ type Observer interface

+ Observe func(ctx context.Context, event Observation)

+ func EnsureObserver(observer Observer) Observer

+ func NopObserver() Observer

+ type ObserverFunc func(context.Context, Observation)

+ func (f ObserverFunc) Observe(ctx context.Context, event Observation)

+ type Operation string

+ const OperationDelete

+ const OperationError

+ const OperationGetHit

+ const OperationGetMiss

+ const OperationSet

+ type PrefixInvalidator interface

+ DeleteByPrefix func(ctx context.Context, prefix string) error

+ type Purgeable interface

+ PurgeExpired func(ctx context.Context) (int, error)

+ type ReadErrorMode uint8

+ const ReadErrorBypass

+ const ReadErrorFail

+ type SetIfAbsentCache interface

+ SetIfAbsent func(ctx context.Context, key K, value V, ttl time.Duration) (bool, error)

+ type SetIfPresentCache interface

+ SetIfPresent func(ctx context.Context, key K, value V, ttl time.Duration) (bool, error)

+ type SingleflightGroup interface

+ Do func(key string, fn func() (any, error)) (any, error, bool)

+ type TagRegistry interface

+ AddTags func(ctx context.Context, key string, tags []string) error

+ InvalidateTags func(ctx context.Context, tags []string) error

+ type TypedPrefixInvalidator interface

+ DeleteByKeyPrefix func(ctx context.Context, prefix K) error

+ type TypedTagRegistry interface

+ AddTagsForKey func(ctx context.Context, key K, tags []string) error

+ InvalidateTags func(ctx context.Context, tags []string) error

+ type WriteErrorMode uint8

+ const WriteErrorFail

+ const WriteErrorIgnore

v0.1.0

Feb 24, 2026