lru

README

go-lru

Simple thread-safe generic Go LRU cache implementation

Installation

go get github.com/notEpsilon/go-lru

Usage

using the cache is very simple

cache := lru.New[int, string](2) // give capacity

cache.Put(1, "fish")

value, err := cache.Get(1) // returns an error if the key wasn't found
if err != nil {
  panic(err)
}

fmt.Println(value) // fish

Documentation

Index

• type LRUCache
  • func New[K comparable, V any](capacity int) (*LRUCache[K, V], error)
  • func (c *LRUCache[K, V]) Capacity() int
  • func (c *LRUCache[K, V]) Contains(key K) bool
  • func (c *LRUCache[K, V]) Get(key K) (V, error)
  • func (c *LRUCache[K, V]) Peek(key K) (V, error)
  • func (c *LRUCache[K, V]) Remove(key K)
  • func (c *LRUCache[K, V]) Set(key K, value V)
  • func (c *LRUCache[K, V]) Size() int

Types

type LRUCache

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

func New

func New[K comparable, V any](capacity int) (*LRUCache[K, V], error)

func (*LRUCache[K, V]) Capacity

func (c *LRUCache[K, V]) Capacity() int

func (*LRUCache[K, V]) Contains

func (c *LRUCache[K, V]) Contains(key K) bool

func (*LRUCache[K, V]) Get

func (c *LRUCache[K, V]) Get(key K) (V, error)

func (*LRUCache[K, V]) Peek

func (c *LRUCache[K, V]) Peek(key K) (V, error)

func (*LRUCache[K, V]) Remove

func (c *LRUCache[K, V]) Remove(key K)

func (*LRUCache[K, V]) Set

func (c *LRUCache[K, V]) Set(key K, value V)

func (*LRUCache[K, V]) Size

func (c *LRUCache[K, V]) Size() int