lru

Documentation

Overview

Package lru implements a generic Least Recently Used (LRU) cache with support for "spam" items. The cache maintains a maximum number of items, evicting the least recently used item when the limit is reached. Items can be added, retrieved, and deleted from the cache. Regular items are moved to the front of the cache when accessed or updated, while "spam" items maintain their position. This allows for preferential treatment of non-spam items in terms of retention, while still caching spam items. The cache is safe for concurrent use.

Index

• type Cache
  • func NewCache[K comparable, V any](maxItems int) *Cache[K, V]
  • func (c *Cache[K, V]) Delete(key K)
  • func (c *Cache[K, V]) Get(key K) (v V, found bool)
  • func (c *Cache[K, V]) Set(key K, value V, isSpam bool)

Types

type Cache

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

Cache is a generic LRU cache that supports "spam" items.

func NewCache

func NewCache[K comparable, V any](maxItems int) *Cache[K, V]

NewCache creates a new LRU cache with the specified maximum number of items.

func (*Cache[K, V]) Delete

func (c *Cache[K, V]) Delete(key K)

Delete removes an item from the cache if it exists.

func (*Cache[K, V]) Get

func (c *Cache[K, V]) Get(key K) (v V, found bool)

Get retrieves an item from the cache, moving non-spam items to the front. It returns the value and a boolean indicating whether the key was found.

func (*Cache[K, V]) Set

func (c *Cache[K, V]) Set(key K, value V, isSpam bool)

Set adds or updates an item in the cache, evicting the LRU item if necessary. The isSpam parameter determines whether the item should be treated as spam. If the item is spam, it will not be moved to the front of the cache.