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

cache

package module

Go to main page

Versions in this module

v0

v0.4.0

Mar 1, 2025

Changes in this version

+ type InvolvedObject struct

+ Kind string

+ Name string

+ Namespace string

type LRU

+ func (c *LRU[T]) GetIfOrSet(ctx context.Context, key string, condition func(T) bool, ...) (value T, ok bool, err error)

type Options

+ func WithInvolvedObject(kind, name, namespace string) Options

+ type Token interface

+ GetDuration func() time.Duration

+ type TokenCache struct

+ func NewTokenCache(capacity int, opts ...Options) *TokenCache

+ func (c *TokenCache) DeleteCacheEvent(event, kind, name, namespace string)

+ func (c *TokenCache) GetOrSet(ctx context.Context, key string, newToken func(context.Context) (Token, error), ...) (Token, bool, error)

v0.3.0

Jan 31, 2025

v0.2.0

Dec 12, 2024

v0.1.0

Dec 5, 2024

Changes in this version

type Cache

+ func (c *Cache[T]) DeleteCacheEvent(event, kind, name, namespace string)

+ func (c *Cache[T]) RecordCacheEvent(event, kind, name, namespace string)

type LRU

+ func (c *LRU[T]) DeleteCacheEvent(event, kind, name, namespace string)

+ func (c *LRU[T]) RecordCacheEvent(event, kind, name, namespace string)

type Options

+ func WithMetricsPrefix(prefix string) Options

v0.0.4

Sep 13, 2024

v0.0.3

Aug 15, 2024

v0.0.2

Aug 14, 2024

v0.0.1

Jun 14, 2024

Changes in this version

+ const CacheEventTypeHit

+ const CacheEventTypeMiss

+ const StatusFailure

+ const StatusSuccess

+ var ErrAlreadyExists = CacheErrorReason

+ var ErrCacheClosed = CacheErrorReason

+ var ErrCacheFull = CacheErrorReason

+ var ErrInvalidKey = CacheErrorReason

+ var ErrInvalidLabels = CacheErrorReason

+ var ErrInvalidSize = CacheErrorReason

+ var ErrNotFound = CacheErrorReason

+ var IdentifiableObjectLabels []string = []string

+ func IdentifiableObjectKeyFunc[T any](object T) (string, error)

+ func IdentifiableObjectLVSFunc[T any](object T, cardinality int) ([]string, error)

+ func MustMakeMetrics(r prometheus.Registerer, m *cacheMetrics)

+ func StoreObjectKeyFunc[T any](object StoreObject[T]) (string, error)

+ type Cache struct

+ func New[T any](capacity int, keyFunc KeyFunc[T], opts ...Options[T]) (*Cache[T], error)

+ func (c *Cache[T]) Close() error

+ func (c *Cache[T]) Delete(object T) error

+ func (c *Cache[T]) Get(object T) (item T, exists bool, err error)

+ func (c *Cache[T]) GetByKey(key string) (T, bool, error)

+ func (c *Cache[T]) GetExpiration(object T) (time.Time, error)

+ func (c *Cache[T]) HasExpired(object T) (bool, error)

+ func (c *Cache[T]) Set(object T) error

+ func (c *Cache[T]) SetExpiration(object T, expiration time.Time) error

+ func (c Cache) Clear()

+ func (c Cache) ListKeys() ([]string, error)

+ func (c Cache) Resize(size int) (int, error)

+ type CacheError struct

+ Err error

+ Reason CacheErrorReason

+ func (e *CacheError) Error() string

+ func (e *CacheError) Is(target error) bool

+ func (e *CacheError) Unwrap() error

+ type CacheErrorReason struct

+ func (e CacheErrorReason) Error() string

+ type Expirable interface

+ GetExpiration func(object T) (time.Time, error)

+ HasExpired func(object T) (bool, error)

+ SetExpiration func(object T, expiresAt time.Time) error

+ type ExplicitKey string

+ type GetLvsFunc func(obj T, cardinality int) ([]string, error)

+ type IdentifiableObject struct

+ Object any

+ type KeyFunc func(object T) (string, error)

+ type LRU struct

+ func NewLRU[T any](capacity int, keyFunc KeyFunc[T], opts ...Options[T]) (*LRU[T], error)

+ func (c *LRU[T]) Delete(object T) error

+ func (c *LRU[T]) Get(object T) (item T, exists bool, err error)

+ func (c *LRU[T]) GetByKey(key string) (T, bool, error)

+ func (c *LRU[T]) ListKeys() ([]string, error)

+ func (c *LRU[T]) Resize(size int) (int, error)

+ func (c *LRU[T]) Set(object T) error

+ type Options func(*storeOptions[T]) error

+ func WithCleanupInterval[T any](interval time.Duration) Options[T]

+ func WithMetricsLabels[T any](labels []string, f GetLvsFunc[T]) Options[T]

+ func WithMetricsRegisterer[T any](r prometheus.Registerer) Options[T]

+ type Store interface

+ Delete func(object T) error

+ Get func(object T) (item T, exists bool, err error)

+ GetByKey func(key string) (item T, exists bool, err error)

+ ListKeys func() ([]string, error)

+ Resize func(int) (int, error)

+ Set func(object T) error

+ type StoreObject struct

+ Key string

+ Object T