cache

Documentation

Index

• Constants
• func DecorateFunction[T any, R any](cache Cache[T, R], fn func(T) (R, error)) func(T) (R, error)
• func DefaultCacheResultPredicate(_ any, _ error) bool
• func DefaultKeyToHash(key any) (uint64, uint64)
• type Cache
  • func NewCache[K any, V any](name string, configs ...ConfigBuilder) Cache[K, V]
• type Config
  • func (config *Config) String() string
• type ConfigBuilder
  • func WithCacheResultPredicate(function func(any, error) bool) ConfigBuilder
  • func WithCapacity(capacity int64) ConfigBuilder
  • func WithItemTTL(itemTTL time.Duration) ConfigBuilder
  • func WithKeyToHash(function func(any) (uint64, uint64)) ConfigBuilder
• type Event
• type EventListener
• type EventType
• type HitEvent
• type Metrics
• type MissEvent

Constants

const DefaultCapacity int64 = 10000

const DefaultItemTTL = time.Minute * 5

Functions

func DecorateFunction

func DecorateFunction[T any, R any](cache Cache[T, R], fn func(T) (R, error)) func(T) (R, error)

func DefaultCacheResultPredicate

func DefaultCacheResultPredicate(_ any, _ error) bool

func DefaultKeyToHash

func DefaultKeyToHash(key any) (uint64, uint64)

Types

type Cache

type Cache[K any, V any] interface {
	Name() string
	Metrics() Metrics
	EventListener() EventListener
	WithMarshalFn(func(V) any, func(any) V) Cache[K, V]
	GetOrLoad(key K, loader func(K) (V, error)) (V, error)
}

func NewCache

func NewCache[K any, V any](name string, configs ...ConfigBuilder) Cache[K, V]

type Config

type Config struct {
	// contains filtered or unexported fields
}

func (*Config) String

func (config *Config) String() string

type ConfigBuilder

type ConfigBuilder func(*Config)

func WithCacheResultPredicate

func WithCacheResultPredicate(function func(any, error) bool) ConfigBuilder

func WithCapacity

func WithCapacity(capacity int64) ConfigBuilder

func WithItemTTL

func WithItemTTL(itemTTL time.Duration) ConfigBuilder

func WithKeyToHash

func WithKeyToHash(function func(any) (uint64, uint64)) ConfigBuilder

type Event

type Event interface {
	fmt.Stringer
	CacheName() string
	CreationTime() time.Time
	CacheKey() any
	EventType() EventType
}

type EventListener

type EventListener interface {
	OnCacheHitFunc(func(HitEvent)) EventListener
	OnCacheMissFunc(func(MissEvent)) EventListener
	DismissCacheHitFunc(func(HitEvent)) EventListener
	DismissCacheMissFunc(func(MissEvent)) EventListener

	OnCacheHit(fn.Consumer[HitEvent]) EventListener
	OnCacheMiss(fn.Consumer[MissEvent]) EventListener
	DismissCacheHit(fn.Consumer[HitEvent]) EventListener
	DismissCacheMiss(fn.Consumer[MissEvent]) EventListener
}

type EventType

type EventType string

const (
	OnHit  EventType = "CACHE_HIT"
	OnMiss EventType = "CACHE_MISS"
)

type HitEvent

type HitEvent interface {
	Event
}

type Metrics

type Metrics interface {
	NumberOfCacheHits() uint64
	NumberOfCacheMisses() uint64
}

type MissEvent

type MissEvent interface {
	Event
}