Documentation
¶
Overview ¶
Package cache implements a LRU cache.
The implementation borrows heavily from SmallLRUCache (originally by Nathan Schrenk). The object maintains a doubly-linked list of elements. When an element is accessed, it is promoted to the head of the list. When space is needed, the element at the tail of the list (the least recently used element) is evicted.
Index ¶
- type Item
- type LRUCache
- func (lru *LRUCache[T]) Delete(key string)
- func (lru *LRUCache[T]) Evictions() int64
- func (lru *LRUCache[T]) Get(key string) (v T, ok bool)
- func (lru *LRUCache[T]) Hits() int64
- func (lru *LRUCache[T]) Items() []Item[T]
- func (lru *LRUCache[T]) Len() int
- func (lru *LRUCache[T]) MaxCapacity() int64
- func (lru *LRUCache[T]) Misses() int64
- func (lru *LRUCache[T]) Set(key string, value T) bool
- func (lru *LRUCache[T]) SetCapacity(capacity int64)
- func (lru *LRUCache[T]) UsedCapacity() int64
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LRUCache ¶
type LRUCache[T any] struct { // contains filtered or unexported fields }
LRUCache is a typical LRU cache implementation. If the cache reaches the capacity, the least recently used item is deleted from the cache.
func NewLRUCache ¶
NewLRUCache creates a new empty cache with the given capacity.
func (*LRUCache[T]) Get ¶
Get returns a value from the cache, and marks the entry as most recently used.
func (*LRUCache[T]) Items ¶
Items returns all the values for the cache, ordered from most recently used to least recently used.
func (*LRUCache[T]) MaxCapacity ¶ added in v0.10.0
MaxCapacity returns the cache maximum capacity.
func (*LRUCache[T]) SetCapacity ¶
SetCapacity will set the capacity of the cache. If the capacity is smaller, and the current cache size exceed that capacity, the cache will be shrank.
func (*LRUCache[T]) UsedCapacity ¶ added in v0.10.0
UsedCapacity returns the size of the cache (in bytes)
Source Files
Directories