package simplelru

import "github.com/hashicorp/vault/vendor/github.com/hashicorp/golang-lru/simplelru"

Index ¶

• type EvictCallback
• type LRU
• func NewLRU(size int, onEvict EvictCallback) (*LRU, error)
• func (c *LRU) Add(key, value interface{}) (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) Resize(size int) (evicted int)
• type LRUCache

Package Files ¶

lru.go lru_interface.go

type EvictCallback ¶ Uses

type EvictCallback func(key interface{}, value interface{})

EvictCallback is used to get a callback when a cache entry is evicted

type LRU ¶ Uses

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

LRU implements a non-thread safe fixed size LRU cache

func NewLRU ¶ Uses

func NewLRU(size int, onEvict EvictCallback) (*LRU, error)

NewLRU constructs an LRU of the given size

func (*LRU) Add ¶ Uses

func (c *LRU) Add(key, value interface{}) (evicted bool)

Add adds a value to the cache. Returns true if an eviction occurred.

func (*LRU) Contains ¶ Uses

func (c *LRU) Contains(key interface{}) (ok bool)

Contains checks if a key is in the cache, without updating the recent-ness or deleting it for being stale.

func (*LRU) Get ¶ Uses

func (c *LRU) Get(key interface{}) (value interface{}, ok bool)

Get looks up a key's value from the cache.

func (*LRU) GetOldest ¶ Uses

func (c *LRU) GetOldest() (key interface{}, value interface{}, ok bool)

GetOldest returns the oldest entry

func (*LRU) Keys ¶ Uses

func (c *LRU) Keys() []interface{}

Keys returns a slice of the keys in the cache, from oldest to newest.

func (*LRU) Len ¶ Uses

func (c *LRU) Len() int

Len returns the number of items in the cache.

func (*LRU) Peek ¶ Uses

func (c *LRU) Peek(key interface{}) (value interface{}, ok bool)

Peek returns the key value (or undefined if not found) without updating the "recently used"-ness of the key.

func (*LRU) Purge ¶ Uses

func (c *LRU) Purge()

Purge is used to completely clear the cache.

func (*LRU) Remove ¶ Uses

func (c *LRU) Remove(key interface{}) (present bool)

Remove removes the provided key from the cache, returning if the key was contained.

func (*LRU) RemoveOldest ¶ Uses

func (c *LRU) RemoveOldest() (key interface{}, value interface{}, ok bool)

RemoveOldest removes the oldest item from the cache.

func (*LRU) Resize ¶ Uses

func (c *LRU) Resize(size int) (evicted int)

Resize changes the cache size.

type LRUCache ¶ Uses

type LRUCache interface {
    // Adds a value to the cache, returns true if an eviction occurred and
    // updates the "recently used"-ness of the key.
    Add(key, value interface{}) 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)

    // Checks if a key exists 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

    // Clears all cache entries.
    Purge()

    // Resizes cache, returning number evicted
    Resize(int) int
}

LRUCache is the interface for simple LRU cache.