lru

Documentation

Index

• type Cache
  • func New[K comparable, V any](size int) *Cache[K, V]
  • func (l *Cache[K, V]) Add(key K, value V) (evicted bool)
  • func (l *Cache[K, V]) Get(key K) (V, bool)
  • func (l *Cache[K, V]) Len() int
  • func (l *Cache[K, V]) Purge()
  • func (l *Cache[K, V]) Remove(key K) (present bool)
• type SimpleCache
  • func NewSimple[K comparable, V any](size int) *SimpleCache[K, V]
  • func (l *SimpleCache[K, V]) Add(key K, value V) (evicted bool)
  • func (l *SimpleCache[K, V]) Get(key K) (V, bool)
  • func (l *SimpleCache[K, V]) Len() int
  • func (l *SimpleCache[K, V]) Purge()
  • func (l *SimpleCache[K, V]) Remove(key K) (present bool)

Types

type Cache

type Cache[K comparable, V any] struct {
	// contains filtered or unexported fields
}

Cache is a thread-safe size-bounded LRU cache.

func New

func New[K comparable, V any](size int) *Cache[K, V]

New returns a new thread-safe LRU cache or panics if size <= 0. Use for caches sized by constants or validated config, where a zero size indicates a programmer error rather than a runtime condition.

func (*Cache[K, V]) Add

func (l *Cache[K, V]) Add(key K, value V) (evicted bool)

func (*Cache[K, V]) Get

func (l *Cache[K, V]) Get(key K) (V, bool)

func (*Cache[K, V]) Len

func (l *Cache[K, V]) Len() int

func (*Cache[K, V]) Purge

func (l *Cache[K, V]) Purge()

func (*Cache[K, V]) Remove

func (l *Cache[K, V]) Remove(key K) (present bool)

type SimpleCache

type SimpleCache[K comparable, V any] struct {
	// contains filtered or unexported fields
}

SimpleCache is a non-thread-safe size-bounded LRU cache. Use when external synchronization is provided (e.g. single-goroutine ownership).

func NewSimple

func NewSimple[K comparable, V any](size int) *SimpleCache[K, V]

NewSimple returns a new non-thread-safe LRU cache or panics if size <= 0.

func (*SimpleCache[K, V]) Add

func (l *SimpleCache[K, V]) Add(key K, value V) (evicted bool)

func (*SimpleCache[K, V]) Get

func (l *SimpleCache[K, V]) Get(key K) (V, bool)

func (*SimpleCache[K, V]) Len

func (l *SimpleCache[K, V]) Len() int

func (*SimpleCache[K, V]) Purge

func (l *SimpleCache[K, V]) Purge()

func (*SimpleCache[K, V]) Remove

func (l *SimpleCache[K, V]) Remove(key K) (present bool)