ttllru

Documentation

Index

• type Cache
  • func (ttlCache *Cache) Add(key interface{}, val interface{}) bool
  • func (ttlCache *Cache) Get(key interface{}) (value interface{}, ok bool)
  • func (ttlCache *Cache) Peek(key interface{}) (value interface{}, expiration time.Time, ok bool)
• type Cacher
• type PeekingCacher
  • func New(size int, timeToLive time.Duration) (PeekingCacher, error)

Types

type Cache

type Cache struct {
	Cacher
	TimeToLive time.Duration
	// contains filtered or unexported fields
}

Cache is a TTL LRU cache which caches items with a max time to live and with bounded length.

func (*Cache) Add

func (ttlCache *Cache) Add(key interface{}, val interface{}) bool

Add will add a value for a given key.

func (*Cache) Get

func (ttlCache *Cache) Get(key interface{}) (value interface{}, ok bool)

Get returns a value and a bool indicating the value was found for a given key.

func (*Cache) Peek

func (ttlCache *Cache) Peek(key interface{}) (value interface{}, expiration time.Time, ok bool)

Peek will fetch an item from the cache, but will not update the expiration time.

type Cacher

type Cacher interface {
	Get(key interface{}) (value interface{}, ok bool)
	Add(key interface{}, value interface{}) (evicted bool)
	Remove(key interface{}) (ok bool)
}

Cacher describes a basic cache.

type PeekingCacher

type PeekingCacher interface {
	Cacher
	Peek(key interface{}) (value interface{}, expiration time.Time, ok bool)
}

PeekingCacher describes a basic cache with the ability to peek.

func New

func New(size int, timeToLive time.Duration) (PeekingCacher, error)

New creates a new TTL LRU cache which caches items with a max time to live and with bounded length.