cache

Documentation

Index

• type LRU
  • func NewLRU[T any](capacity int, onEvict OnEvict[T]) *LRU[T]
  • func (l *LRU[T]) Get(key string, removeIfFound bool) *T
  • func (l *LRU[T]) Purge() error
  • func (l *LRU[T]) Put(key string, value *T) error
• type OnEvict
• type Value
  • func (cv *Value[T]) Get(loader func() (T, error), ttl *time.Time) (T, error)

Types

type LRU

type LRU[T any] struct {
	// contains filtered or unexported fields
}

func NewLRU

func NewLRU[T any](capacity int, onEvict OnEvict[T]) *LRU[T]

func (*LRU[T]) Get

func (l *LRU[T]) Get(key string, removeIfFound bool) *T

func (*LRU[T]) Purge

func (l *LRU[T]) Purge() error

func (*LRU[T]) Put

func (l *LRU[T]) Put(key string, value *T) error

type OnEvict

type OnEvict[T any] func(key string, value *T) error

type Value

type Value[T any] struct {
	// contains filtered or unexported fields
}

Value creates a thread safe cache value accessible with Get

func (*Value[T]) Get

func (cv *Value[T]) Get(loader func() (T, error), ttl *time.Time) (T, error)

Get reads the cache value, calling the loader function to populate the cache putVal if it is not currently set. ttl sets the expiration date of the cache putVal, after which time it will be reloaded. Setting ttl to nil will prevent the cache from expiring.