disk

Documentation

Index

• func New(dir string, maxSizeBytes int64, readOnly bool) cache.Cache
• type EvictCallback
• type Key
• type SizedItem
• type SizedLRU
  • func NewSizedLRU(maxSize int64, onEvict EvictCallback) SizedLRU

Functions

func New

func New(dir string, maxSizeBytes int64, readOnly bool) cache.Cache

New returns a new instance of a filesystem-based cache rooted at `dir`, with a maximum size of `maxSizeBytes` bytes.

Types

type EvictCallback

type EvictCallback func(key Key, value SizedItem)

EvictCallback is the type of callbacks that are invoked when items are evicted.

type Key

type Key interface{}

type SizedItem

type SizedItem interface {
	Size() int64
}

type SizedLRU

type SizedLRU interface {
	Add(key Key, value SizedItem) (ok bool)
	Get(key Key) (value SizedItem, ok bool)
	Remove(key Key)
	Len() int
	CurrentSize() int64
	MaxSize() int64
}

SizedLRU is an LRU cache that will keep its total size below maxSize by evicting items. SizedLRU is not thread-safe.

func NewSizedLRU

func NewSizedLRU(maxSize int64, onEvict EvictCallback) SizedLRU

NewSizedLRU returns a new sizedLRU cache