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

Go to main page

Versions in this module

v0

v0.1.5

Nov 26, 2025

Changes in this version

+ const DefaultBufferSize

+ const DefaultCleanupInterval

+ const DefaultHistorySize

+ const DefaultItemsPerCleanup

+ const DefaultShardCount

type Cache

+ func New[K comparable, V any](config Config) *Cache[K, V]

+ func (c *Cache[K, V]) AddToListWithLimit(key K, value V, maxSize int)

+ type Config struct

+ AutoPersistInterval time.Duration

+ CleanupInterval time.Duration

+ PersistPath string

+ ShardCount int

+ TTL time.Duration

+ func DefaultConfig() *Config

+ type Shard struct

v0.1.4

Mar 24, 2025

Changes in this version

+ type Cache struct

+ func NewCacheWithPersistence[K comparable, V any](defaultExpiration, cleanupInterval time.Duration, persistPath string, ...) *Cache[K, V]

+ func NewCache[K comparable, V any](defaultExpiration, cleanupInterval time.Duration) *Cache[K, V]

+ func (c *Cache[K, V]) BLPop(key K, timeout time.Duration) (V, bool)

+ func (c *Cache[K, V]) BRPop(key K, timeout time.Duration) (V, bool)

+ func (c *Cache[K, V]) BRPopLPush(source K, destination K, timeout time.Duration) (V, bool)

+ func (c *Cache[K, V]) BeginTransaction() *Transaction[K, V]

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

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

+ func (c *Cache[K, V]) Count() int

+ func (c *Cache[K, V]) Delete(key K)

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

+ func (c *Cache[K, V]) DeleteList(key K)

+ func (c *Cache[K, V]) DisableAutoPersist()

+ func (c *Cache[K, V]) EnableAutoPersist()

+ func (c *Cache[K, V]) Flush() error

+ func (c *Cache[K, V]) ForEach(fn func(key K, value V) bool)

+ func (c *Cache[K, V]) ForEachList(fn func(key K, list []V) bool)

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

+ func (c *Cache[K, V]) GetListTTL(key K) (time.Duration, bool)

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

+ func (c *Cache[K, V]) GetTTL(key K) (time.Duration, bool)

+ func (c *Cache[K, V]) GetWithTTL(key K) (V, time.Duration, bool)

+ func (c *Cache[K, V]) Has(key K) bool

+ func (c *Cache[K, V]) HasList(key K) bool

+ func (c *Cache[K, V]) Increment(key K, increment any) (any, error)

+ func (c *Cache[K, V]) Keys() []K

+ func (c *Cache[K, V]) LIndex(key K, index int) (V, bool)

+ func (c *Cache[K, V]) LInsert(key K, before bool, pivot V, value V, equals func(a, b V) bool) int

+ func (c *Cache[K, V]) LLen(key K) int

+ func (c *Cache[K, V]) LPop(key K) (V, bool)

+ func (c *Cache[K, V]) LPush(key K, values ...V) int

+ func (c *Cache[K, V]) LRange(key K, start, stop int) []V

+ func (c *Cache[K, V]) LRem(key K, count int, value V, equals func(a, b V) bool) int

+ func (c *Cache[K, V]) LSet(key K, index int, value V) bool

+ func (c *Cache[K, V]) LTrim(key K, start, stop int) bool

+ func (c *Cache[K, V]) ListCount() int

+ func (c *Cache[K, V]) ListKeys() []K

+ func (c *Cache[K, V]) Load() error

+ func (c *Cache[K, V]) LoadOrInit() error

+ func (c *Cache[K, V]) RPop(key K) (V, bool)

+ func (c *Cache[K, V]) RPoplPush(source K, destination K) (V, bool)

+ func (c *Cache[K, V]) RPush(key K, values ...V) int

+ func (c *Cache[K, V]) Save() error

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

+ func (c *Cache[K, V]) SetList(key K, duration ...time.Duration)

+ func (c *Cache[K, V]) WithPersistence(persistPath string, autoPersistInterval time.Duration) *Cache[K, V]

+ type CacheItem struct

+ Expiration int64

+ Value T

+ type ListItem struct

+ Value T

+ type PersistenceData struct

+ DefaultExpiration time.Duration

+ Expiration map[K]int64

+ Items map[K]CacheItem[V]

+ ListItems map[K][]ListItem[V]

+ type Stats struct

+ CreationTime time.Time

+ DeletedCount uint64

+ ExpiredCount uint64

+ HitCount uint64

+ IsAutoPersist bool

+ ItemsCount int

+ LastLoadTime time.Time

+ LastSaveTime time.Time

+ ListsCount int

+ MemoryUsage uint64

+ MissCount uint64

+ PersistPath string

+ SaveInterval time.Duration

+ type Transaction struct

+ func (t *Transaction[K, V]) Commit()

+ func (t *Transaction[K, V]) Delete(key K)

+ func (t *Transaction[K, V]) DeleteList(key K)

+ func (t *Transaction[K, V]) LPush(key K, values ...V)

+ func (t *Transaction[K, V]) Rollback()

+ func (t *Transaction[K, V]) Set(key K, value V, duration time.Duration)

+ func (t *Transaction[K, V]) SetListExpiration(key K, duration time.Duration)