lrucache

package module

v0.0.0-...-735e4c3 Latest Latest Go to latest Published: Jun 5, 2016 License: Apache-2.0 Imports: 4 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

lrucache implements a simple memory-based LRU cache.

This section is empty.

View Source

var (
	ErrNotFound  = errors.New("item not found")
	ErrNotStored = errors.New("item not stored")
)

This section is empty.

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

Cache is a thread-safe fixed size LRU cache.

func New(size int) *Cache

New creates an LRU cache of the given size. if size<=0, will panic.

func (cache *Cache) Add(key Key, value Value) (err error)

Add adds key-value to cache. if there already exists a item with the same key, it returns ErrNotStored.

NOTE: the comparison operators == and != must be fully defined for
      operands of the key type.

func (cache *Cache) Get(key Key) (value Value, err error)

Get looks up a key's value from the cache. if there is no such item with the key it returns ErrNotFound.

NOTE: the comparison operators == and != must be fully defined for
      operands of the key type.

func (cache *Cache) Len() (n int)

Len returns the number of items in the cache.

func (cache *Cache) Purge()

Purge is used to completely clear the cache

func (cache *Cache) Remove(key Key) (err error)

Remove removes the provided key from the cache. if there is no such item with the key it returns ErrNotFound, normally you can ignore this error.

NOTE: the comparison operators == and != must be fully defined for
      operands of the key type.

func (cache *Cache) Set(key Key, value Value) (err error)

Set sets key-value to cache, unconditional

NOTE: the comparison operators == and != must be fully defined for
      operands of the key type.

func (cache *Cache) SetSize(size int)

SetSize sets a new size for the cache. if size <=0, we do nothing.

func (cache *Cache) Size() (size int)

Size returns the size of cache.

type Key interface{} // can changes to explicit type you want

type Value interface{} // can changes to explicit type you want