cache

Documentation

Index

• func WithCache[R any](cache Cache, cfg *Cfg, cacheKey []byte, onCacheMiss func() (*R, error)) (*R, error)
• type Cache
  • func NewCache(nrElems int, logger log.Logger) (Cache, error)
  • func NewNoOpCache() Cache
  • func NewRistrettoCacheWithEviction(nrElems int, logger log.Logger) (Cache, error)
• type Cfg
• type Strategy

Functions

func WithCache

func WithCache[R any](cache Cache, cfg *Cfg, cacheKey []byte, onCacheMiss func() (*R, error)) (*R, error)

Types

type Cache

type Cache interface {
	// EvictShortLiving - notify the cache that all short living elements cached before the events should be considered as evicted.
	EvictShortLiving()

	// DisableShortLiving disables the caching of short-living elements.
	DisableShortLiving()

	// IsEvicted - based on the eviction event and the time of caching, calculates whether the key was evicted
	IsEvicted(key []byte, originalTTL time.Duration) bool

	Set(key []byte, value any, ttl time.Duration) bool
	Get(key []byte) (value any, ok bool)
	Remove(key []byte)
}

func NewCache

func NewCache(nrElems int, logger log.Logger) (Cache, error)

func NewNoOpCache

func NewNoOpCache() Cache

func NewRistrettoCacheWithEviction

func NewRistrettoCacheWithEviction(nrElems int, logger log.Logger) (Cache, error)

NewRistrettoCacheWithEviction returns a new ristrettoCache.

type Cfg

type Cfg struct {
	Type        Strategy
	DynamicType func() Strategy
}

type Strategy

type Strategy uint8

const (
	NoCache     Strategy = iota
	LatestBatch Strategy = iota
	LongLiving  Strategy = iota
)