lru_map

README

lru_map

Extremely basic in-memory LRU cache, with the semantics of a generic map.

Reads and writes are O(1), by tracking key age using a linked list.

Documentation

Overview

Package lru_map implements an extremely basic in-memory LRU cache.

Index

• type LRUMap
  • func New[K comparable, V any](capacity int) LRUMap[K, V]

Types

type LRUMap

type LRUMap[K comparable, V any] interface {
	// Associate a value with a key in the map. If the map is full, the oldest
	// entry will be deleted.
	Set(K, V)
	// Retrieve the value associated with the given key. If the value is not
	// present, it will return false. This can happen either because the value
	// has not been set for the key, or its entry has been evicted.
	Get(K) (V, bool)
	// Remove an element from the map. This can improve efficiency as it allows
	// other objects to remain cached for longer.
	Drop(K)
	// Get all the keys present in the map.
	Keys() iter.Seq[K]
}

An LRUMap is a generic Map type, with an LRU eviction policy.

func New

func New[K comparable, V any](capacity int) LRUMap[K, V]

Create a new LRUMap, with a given fixed capacity.