cache

Documentation

Overview

The implementation borrows heavily from SmallLRUCache (originally by Nathan Schrenk). The object maintains a doubly-linked list of elements in the When an element is accessed it is promoted to the head of the list, and 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 NewLRUCache(capacity uint64) *LRUCache
  • func (lru *LRUCache) Clear()
  • func (lru *LRUCache) Delete(key string) bool
  • func (lru *LRUCache) Get(key string) (v Value, ok bool)
  • func (lru *LRUCache) Items() []Item
  • func (lru *LRUCache) Keys() []string
  • func (lru *LRUCache) LoadItems(r io.Reader) error
  • func (lru *LRUCache) LoadItemsFromFile(path string) error
  • func (lru *LRUCache) SaveItems(w io.Writer) error
  • func (lru *LRUCache) SaveItemsToFile(path string) error
  • func (lru *LRUCache) Set(key string, value Value)
  • func (lru *LRUCache) SetCapacity(capacity uint64)
  • func (lru *LRUCache) SetIfAbsent(key string, value Value)
  • func (lru *LRUCache) Stats() (length, size, capacity uint64, oldest time.Time)
  • func (lru *LRUCache) StatsJSON() string
• type Value

Types

type Item

type Item struct {
	Key   string
	Value Value
}

type LRUCache

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

func NewLRUCache

func NewLRUCache(capacity uint64) *LRUCache

func (*LRUCache) Clear

func (lru *LRUCache) Clear()

func (*LRUCache) Delete

func (lru *LRUCache) Delete(key string) bool

func (*LRUCache) Get

func (lru *LRUCache) Get(key string) (v Value, ok bool)

func (*LRUCache) Items

func (lru *LRUCache) Items() []Item

func (*LRUCache) Keys

func (lru *LRUCache) Keys() []string

func (*LRUCache) LoadItems

func (lru *LRUCache) LoadItems(r io.Reader) error

func (*LRUCache) LoadItemsFromFile

func (lru *LRUCache) LoadItemsFromFile(path string) error

func (*LRUCache) SaveItems

func (lru *LRUCache) SaveItems(w io.Writer) error

func (*LRUCache) SaveItemsToFile

func (lru *LRUCache) SaveItemsToFile(path string) error

func (*LRUCache) Set

func (lru *LRUCache) Set(key string, value Value)

func (*LRUCache) SetCapacity

func (lru *LRUCache) SetCapacity(capacity uint64)

func (*LRUCache) SetIfAbsent

func (lru *LRUCache) SetIfAbsent(key string, value Value)

func (*LRUCache) Stats

func (lru *LRUCache) Stats() (length, size, capacity uint64, oldest time.Time)

func (*LRUCache) StatsJSON

func (lru *LRUCache) StatsJSON() string

type Value

type Value interface {
	Size() int
}

Values that go into LRUCache need to satisfy this interface.