Documentation
¶
Index ¶
- type EvictCallback
- type LRU
- func (c *LRU) Add(key, value interface{}, size int) (evicted bool)
- func (c *LRU) Contains(key interface{}) (ok bool)
- func (c *LRU) Get(key interface{}) (value interface{}, ok bool)
- func (c *LRU) GetOldest() (key interface{}, value interface{}, ok bool)
- func (c *LRU) Keys() []interface{}
- func (c *LRU) Len() int
- func (c *LRU) Peek(key interface{}) (value interface{}, ok bool)
- func (c *LRU) Purge()
- func (c *LRU) Remove(key interface{}) (present bool)
- func (c *LRU) RemoveOldest() (key interface{}, value interface{}, ok bool)
- func (c *LRU) Size() int
- type LRUCache
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EvictCallback ¶
type EvictCallback func(key interface{}, value interface{}, size int)
EvictCallback is used to get a callback when a cache entry is evicted
type LRU ¶
type LRU struct {
// contains filtered or unexported fields
}
LRU implements a non-thread safe size-aware LRU cache
func NewLRU ¶
func NewLRU(sizeLimit int, onEvict EvictCallback) (*LRU, error)
NewLRU constructs an LRU that should occupy approximately the given size in memory
func NewLRUWithTTL ¶
NewLRUWithTTL constructs a LRU cache with a ttl for elements
func (*LRU) Contains ¶
Contains checks if a key is in the cache, without updating the recent-ness. It may delete it if the key expired
func (*LRU) Keys ¶
func (c *LRU) Keys() []interface{}
Keys returns a slice of the keys in the cache, from oldest to newest.
func (*LRU) Peek ¶
Peek returns the key value (or undefined if not found) without updating the "recently used"-ness of the key.
func (*LRU) Remove ¶
Remove removes the provided key from the cache, returning if the key was contained.
func (*LRU) RemoveOldest ¶
RemoveOldest removes the oldest item from the cache.
type LRUCache ¶
type LRUCache interface {
// Adds a value to the cache, returns true if an eviction occurred
// and updates the "recently used"-ness of the key. Size should be
// the size of the value.
Add(key, value interface{}, size int) bool
// Returns key's value from the cache and
// updates the "recently used"-ness of the key. #value, isFound
Get(key interface{}) (value interface{}, ok bool)
// Check if a key exsists in cache without updating the recent-ness.
Contains(key interface{}) (ok bool)
// Returns key's value without updating the "recently used"-ness of the key.
Peek(key interface{}) (value interface{}, ok bool)
// Removes a key from the cache.
Remove(key interface{}) bool
// Removes the oldest entry from cache.
RemoveOldest() (interface{}, interface{}, bool)
// Returns the oldest entry from the cache. #key, value, isFound
GetOldest() (interface{}, interface{}, bool)
// Returns a slice of the keys in the cache, from oldest to newest.
Keys() []interface{}
// Returns the number of items in the cache.
Len() int
// Returns the total estimated size of the cache
Size() int
// Clear all cache entries
Purge()
}
LRUCache is the interface for simple LRU cache.
Source Files