lru

Documentation

Index

• type EvictCallback
• type LRU
  • func New(size int, onEvict EvictCallback) *LRU
  • func (c *LRU) Add(key, value any) (evicted bool)
  • func (c *LRU) Contains(key any) (ok bool)
  • func (c *LRU) Get(key any) (value any, ok bool)
  • func (c *LRU) GetOldest() (key, value any, ok bool)
  • func (c *LRU) Keys() []any
  • func (c *LRU) Len() int
  • func (c *LRU) Peek(key any) (value any, ok bool)
  • func (c *LRU) Purge()
  • func (c *LRU) Remove(key any) (present bool)
  • func (c *LRU) RemoveOldest() (key, value any, ok bool)
  • func (c *LRU) Resize(size int) (evicted int)

Types

type EvictCallback

type EvictCallback func(key any, value any)

EvictCallback is used to get a callback when a cache entry is evicted

type LRU

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

LRU implements a non-thread safe fixed size LRU cache

func New

func New(size int, onEvict EvictCallback) *LRU

NewLRU constructs an LRU of the given size

func (*LRU) Add

func (c *LRU) Add(key, value any) (evicted bool)

Add adds a value to the cache. Returns true if an eviction occurred.

func (*LRU) Contains

func (c *LRU) Contains(key any) (ok bool)

Contains checks if a key is in the cache, without updating the recent-ness or deleting it for being stale.

func (*LRU) Get

func (c *LRU) Get(key any) (value any, ok bool)

Get looks up a key's value from the cache.

func (*LRU) GetOldest

func (c *LRU) GetOldest() (key, value any, ok bool)

GetOldest returns the oldest entry

func (*LRU) Keys

func (c *LRU) Keys() []any

Keys returns a slice of the keys in the cache, from oldest to newest.

func (*LRU) Len

func (c *LRU) Len() int

Len returns the number of items in the cache.

func (*LRU) Peek

func (c *LRU) Peek(key any) (value any, ok bool)

Peek returns the key value (or undefined if not found) without updating the "recently used"-ness of the key.

func (*LRU) Purge

func (c *LRU) Purge()

Purge is used to completely clear the cache.

func (*LRU) Remove

func (c *LRU) Remove(key any) (present bool)

Remove removes the provided key from the cache, returning if the key was contained.

func (*LRU) RemoveOldest

func (c *LRU) RemoveOldest() (key, value any, ok bool)

RemoveOldest removes the oldest item from the cache.

func (*LRU) Resize

func (c *LRU) Resize(size int) (evicted int)

Resize changes the cache size.