Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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
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

v2

v2.2.2

Mar 18, 2024

v2.2.1

Mar 13, 2024

v2.2.0

Nov 8, 2022

Changes in this version

type Cache

+ func (cache *Cache) SetAllWithTTL(entries map[string]any, ttl time.Duration)

+ func (cache *Cache) WithDefaultTTL(ttl time.Duration) *Cache

v2.1.2

Nov 2, 2022

v2.1.1

Aug 25, 2022

v2.1.0

Aug 4, 2022

Changes in this version

type Cache

+ func (cache *Cache) DeleteKeysByPattern(pattern string) int

v2.0.1

Apr 8, 2022

v2.0.0

Nov 4, 2021

Changes in this version

+ const DefaultMaxSize

+ const Gigabyte

+ const JanitorMaxIterationsPerShift

+ const JanitorMaxShiftBackOff

+ const JanitorMinShiftBackOff

+ const JanitorShiftTarget

+ const Kilobyte

+ const Megabyte

+ const NoExpiration

+ const NoMaxMemoryUsage

+ const NoMaxSize

+ var Debug = false

+ var ErrJanitorAlreadyRunning = errors.New("janitor is already running")

+ var ErrKeyDoesNotExist = errors.New("key does not exist")

+ var ErrKeyHasNoExpiration = errors.New("key has no expiration")

+ func MatchPattern(pattern, s string) bool

+ type Cache struct

+ func NewCache() *Cache

+ func (cache *Cache) Clear()

+ func (cache *Cache) Count() int

+ func (cache *Cache) Delete(key string) bool

+ func (cache *Cache) DeleteAll(keys []string) int

+ func (cache *Cache) EvictionPolicy() EvictionPolicy

+ func (cache *Cache) Expire(key string, ttl time.Duration) bool

+ func (cache *Cache) Get(key string) (interface{}, bool)

+ func (cache *Cache) GetAll() map[string]interface{}

+ func (cache *Cache) GetByKeys(keys []string) map[string]interface{}

+ func (cache *Cache) GetKeysByPattern(pattern string, limit int) []string

+ func (cache *Cache) GetValue(key string) interface{}

+ func (cache *Cache) MaxMemoryUsage() int

+ func (cache *Cache) MaxSize() int

+ func (cache *Cache) MemoryUsage() int

+ func (cache *Cache) Set(key string, value interface{})

+ func (cache *Cache) SetAll(entries map[string]interface{})

+ func (cache *Cache) SetWithTTL(key string, value interface{}, ttl time.Duration)

+ func (cache *Cache) StartJanitor() error

+ func (cache *Cache) Stats() Statistics

+ func (cache *Cache) StopJanitor()

+ func (cache *Cache) TTL(key string) (time.Duration, error)

+ func (cache *Cache) WithEvictionPolicy(policy EvictionPolicy) *Cache

+ func (cache *Cache) WithForceNilInterfaceOnNilPointer(forceNilInterfaceOnNilPointer bool) *Cache

+ func (cache *Cache) WithMaxMemoryUsage(maxMemoryUsageInBytes int) *Cache

+ func (cache *Cache) WithMaxSize(maxSize int) *Cache

+ type Entry struct

+ Expiration int64

+ Key string

+ RelevantTimestamp time.Time

+ Value interface{}

+ func (entry *Entry) Accessed()

+ func (entry *Entry) SizeInBytes() int

+ func (entry Entry) Expired() bool

+ type EvictionPolicy string

+ var FirstInFirstOut EvictionPolicy = "FirstInFirstOut"

+ var LeastRecentlyUsed EvictionPolicy = "LeastRecentlyUsed"

+ type Statistics struct

+ EvictedKeys uint64

+ ExpiredKeys uint64

+ Hits uint64

+ Misses uint64

Other modules containing this package

github.com/TwiN/gocache