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

cache

package module

Go to main page

Versions in this module

v0

v0.3.0

Nov 1, 2026

v0.2.2

Oct 17, 2026

v0.2.1

Oct 14, 2026

v0.2.0

Oct 12, 2026

v0.1.3

Sep 26, 2026

Changes in this version

+ const TagConfig

v0.1.2

Sep 26, 2026

v0.1.1

Sep 26, 2026

v0.1.0

Sep 26, 2026

Changes in this version

+ const ConfigStub

+ const EventFlushed

+ const EventHit

+ const EventKeyForgotten

+ const EventKeyWritten

+ const EventMissed

+ const Forever

+ const MemoryGCInterval

+ var ErrInvalidTTL = errors.New("cache: ttl must be positive; use Forever to store without expiry")

+ var ErrMiss = errors.New("cache: key not found")

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

+ var ErrNotNumeric = errors.New("cache: value is not numeric")

+ var ErrTagsRequireTTL = errors.New(...)

+ var ErrUnsupported = errors.New("cache: operation not supported by this store")

+ func Add(ctx context.Context, key string, value any, ttl time.Duration) (bool, error)

+ func BlockUntil(ctx context.Context, wait, interval time.Duration, ...) (bool, error)

+ func Decrement(ctx context.Context, key string, delta int64) (int64, error)

+ func Flush(ctx context.Context) error

+ func Forget(ctx context.Context, key string) (bool, error)

+ func FormatCounter(n int64) []byte

+ func GetMany[T any](ctx context.Context, keys []string) (map[string]T, error)

+ func Get[T any](ctx context.Context, key string) (T, bool, error)

+ func Has(ctx context.Context, key string) (bool, error)

+ func Increment(ctx context.Context, key string, delta int64) (int64, error)

+ func ParseCounter(value []byte) (int64, error)

+ func Pull[T any](ctx context.Context, key string) (T, bool, error)

+ func Put(ctx context.Context, key string, value any, ttl time.Duration) error

+ func PutForever(ctx context.Context, key string, value any) error

+ func Register(name string, factory Factory)

+ func RememberForever[T any](ctx context.Context, key string, fn func(context.Context) (T, error), ...) (T, error)

+ func Remember[T any](ctx context.Context, key string, ttl time.Duration, ...) (T, error)

+ func RunLocked(ctx context.Context, l Lock, fn func(context.Context) error) (bool, error)

+ func SetGlobal(c *Cache)

+ func SupportedDrivers() []string

+ type Cache struct

+ func FromApp(a app.App) *Cache

+ func Global() *Cache

+ func New(store Store, opts ...Option) *Cache

+ func Tags(names ...string) *Cache

+ func (c *Cache) Add(ctx context.Context, key string, value any, ttl time.Duration) (bool, error)

+ func (c *Cache) Codec() Codec

+ func (c *Cache) Decrement(ctx context.Context, key string, delta int64) (int64, error)

+ func (c *Cache) Flush(ctx context.Context) error

+ func (c *Cache) Forever(ctx context.Context, key string, value any) error

+ func (c *Cache) Forget(ctx context.Context, key string) (bool, error)

+ func (c *Cache) GetAs[T any](ctx context.Context, key string) (T, bool, error)

+ func (c *Cache) GetManyAs[T any](ctx context.Context, keys []string) (map[string]T, error)

+ func (c *Cache) Has(ctx context.Context, key string) (bool, error)

+ func (c *Cache) Increment(ctx context.Context, key string, delta int64) (int64, error)

+ func (c *Cache) Listen(name string, l Listener)

+ func (c *Cache) Lock(name string, ttl time.Duration, opts ...LockOption) Lock

+ func (c *Cache) Missing(ctx context.Context, key string) (bool, error)

+ func (c *Cache) PullAs[T any](ctx context.Context, key string) (T, bool, error)

+ func (c *Cache) Put(ctx context.Context, key string, value any, ttl time.Duration) error

+ func (c *Cache) RememberAs[T any](ctx context.Context, key string, ttl time.Duration, ...) (T, error)

+ func (c *Cache) RememberForeverAs[T any](ctx context.Context, key string, fn func(context.Context) (T, error), ...) (T, error)

+ func (c *Cache) RestoreLock(name, owner string, ttl time.Duration) Lock

+ func (c *Cache) Store() Store

+ func (c *Cache) Tags(names ...string) *Cache

+ type CacheFlushed struct

+ Tags []string

+ func (CacheFlushed) EventName() string

+ type CacheHit struct

+ Key string

+ Tags []string

+ Value []byte

+ func (CacheHit) EventName() string

+ type CacheMissed struct

+ Key string

+ Tags []string

+ func (CacheMissed) EventName() string

+ type Codec interface

+ Marshal func(v any) ([]byte, error)

+ Name func() string

+ Unmarshal func(data []byte, v any) error

+ type Config struct

+ Codec string

+ DefaultTTL time.Duration

+ Driver string

+ Events bool

+ File FileConfig

+ Lenient bool

+ Prefix string

+ Redis RedisConfig

+ func DefaultConfig() *Config

+ type Event interface

+ EventName func() string

+ type Factory func(ctx context.Context, cfg *Config) (Store, error)

+ type FileConfig struct

+ Path string

+ type GobCodec struct

+ func (GobCodec) Marshal(v any) ([]byte, error)

+ func (GobCodec) Name() string

+ func (GobCodec) Unmarshal(data []byte, v any) error

+ type JSONCodec struct

+ func (JSONCodec) Marshal(v any) ([]byte, error)

+ func (JSONCodec) Name() string

+ func (JSONCodec) Unmarshal(data []byte, v any) error

+ type KeyForgotten struct

+ Key string

+ Tags []string

+ func (KeyForgotten) EventName() string

+ type KeyWritten struct

+ Key string

+ TTL time.Duration

+ Tags []string

+ Value []byte

+ func (KeyWritten) EventName() string

+ type Listener func(Event)

+ type Lock interface

+ Acquire func(ctx context.Context) (bool, error)

+ Block func(ctx context.Context, wait time.Duration) (bool, error)

+ ForceRelease func(ctx context.Context) error

+ Get func(ctx context.Context, fn func(context.Context) error) (bool, error)

+ Owner func() string

+ Release func(ctx context.Context) (bool, error)

+ func NewLock(name string, ttl time.Duration, opts ...LockOption) Lock

+ type LockOption func(*lockOptions)

+ func WithOwner(token string) LockOption

+ func WithRetryInterval(d time.Duration) LockOption

+ type LockProvider interface

+ NewLock func(name, owner string, ttl time.Duration) Lock

+ type Option func(*Cache)

+ func WithCodec(c Codec) Option

+ func WithEventSink(sink func(Event)) Option

+ type Provider struct

+ Config *Config

+ func (p *Provider) AddCommands() []app.Command

+ func (p *Provider) AddPublishables() []*app.Publishable

+ func (p *Provider) Cache() *Cache

+ func (p *Provider) Provide(a app.App) error

+ func (p *Provider) Shutdown(context.Context) error

+ type Pruner interface

+ Prune func(ctx context.Context) error

+ type RedisConfig struct

+ Addr string

+ AllowFlushDB bool

+ DB int

+ Password string

+ PoolSize int

+ type RememberOption func(*rememberOptions)

+ func LockFor(ttl time.Duration) RememberOption

+ func WaitFor(d time.Duration) RememberOption

+ type Store interface

+ Add func(ctx context.Context, key string, value []byte, ttl time.Duration) (bool, error)

+ Decrement func(ctx context.Context, key string, delta int64) (int64, error)

+ Flush func(ctx context.Context) error

+ Forget func(ctx context.Context, key string) (bool, error)

+ Get func(ctx context.Context, key string) ([]byte, error)

+ GetMany func(ctx context.Context, keys []string) (map[string][]byte, error)

+ Increment func(ctx context.Context, key string, delta int64) (int64, error)

+ Prefix func() string

+ Put func(ctx context.Context, key string, value []byte, ttl time.Duration) error

+ PutMany func(ctx context.Context, values map[string][]byte, ttl time.Duration) error

+ func Build(ctx context.Context, cfg *Config) (Store, error)

+ type TagIndex interface

+ AddTagEntries func(ctx context.Context, tag string, keys ...string) error

+ ForgetTagEntries func(ctx context.Context, tag string) error

+ TagEntries func(ctx context.Context, tag string) ([]string, error)