lru

README

lru

Simple implementation of LRU caching algorithms

Usage:

import "fmt"

func main() {
	lru, _ := NewLRU(3, func(key string, value interface{}) {
		fmt.Println("Evicted")
		fmt.Println("Key ", key)
		fmt.Println("Value", value)
	})

	lru.Put("a", 1)
	lru.Print()

	lru.Put("b", 2)
	lru.Print()

	lru.Put("c", 3)
	lru.Print()

	lru.Put("d", 4)
	lru.Print()

	lru.Get("b")
	lru.Print()

	lru.Clear()
}

Documentation

Index

• type Cache
• type Elem
• type EvictCallback
• type LRU
  • func NewLRU(c int, f EvictCallback) (*LRU, error)
  • func (lru *LRU) All() []*Elem
  • func (lru *LRU) Clear()
  • func (lru *LRU) Contains(key string) interface{}
  • func (lru *LRU) Get(key string) (interface{}, bool)
  • func (lru *LRU) Init(data []*Elem) bool
  • func (lru *LRU) Len() int
  • func (lru *LRU) Print()
  • func (lru *LRU) Put(key string, value interface{}) (interface{}, bool)
  • func (lru *LRU) Remove(key string) bool

Types

type Cache

type Cache interface {
	Get(key string) (interface{}, bool)
	Put(key string, value interface{}) (interface{}, bool)
	Clear()
	Len() int
	Contins(key string) interface{}
}

type Elem

type Elem struct {
	Key   string
	Value interface{}
}

type EvictCallback

type EvictCallback func(key string, value interface{})

type LRU

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

func NewLRU

func NewLRU(c int, f EvictCallback) (*LRU, error)

func (*LRU) All

func (lru *LRU) All() []*Elem

func (*LRU) Clear

func (lru *LRU) Clear()

func (*LRU) Contains

func (lru *LRU) Contains(key string) interface{}

func (*LRU) Get

func (lru *LRU) Get(key string) (interface{}, bool)

func (*LRU) Init

func (lru *LRU) Init(data []*Elem) bool

func (*LRU) Len

func (lru *LRU) Len() int

func (*LRU) Print

func (lru *LRU) Print()

func (*LRU) Put

func (lru *LRU) Put(key string, value interface{}) (interface{}, bool)

func (*LRU) Remove

func (lru *LRU) Remove(key string) bool