cache

Documentation

Index

• type Cache
  • func NewLRUCache(name string, cap int, opts ...Option) Cache
• type EvictCallback
• type Option
  • func WithEvictCallBack(callback EvictCallback) Option
  • func WithReset() Option
  • func WithTTL(val time.Duration) Option
  • func WithValue2Key() Option

Types

type Cache

type Cache interface {
	// Set a key with value to the cache. Returns true if an item was
	// evicted.
	Set(key, value interface{}) bool

	// Get an item from the cache by key. Returns the value if it exists,
	// and a bool stating whether or not it existed.
	Get(key interface{}) (interface{}, bool)

	// Keys returns a slice of all the keys in the cache
	Keys() []interface{}

	// Len returns the number of items present in the cache
	Len() int

	// Cap returns the total number of items the cache can retain
	Cap() int

	// Purge removes all items from the cache
	Purge()

	// Del deletes an item from the cache by key. Returns if an item was
	// actually deleted.
	Del(key interface{}) bool

	// Del deletes an item from the cache by value. Returns if an item was
	// actually deleted.
	DelByValue(value interface{}) bool
}

func NewLRUCache

func NewLRUCache(name string, cap int, opts ...Option) Cache

New creates a new Cache with cap entries that expire after ttl has elapsed since the item was added, modified or accessed.

type EvictCallback

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

type Option

type Option func(*cache)

func WithEvictCallBack

func WithEvictCallBack(callback EvictCallback) Option

func WithReset

func WithReset() Option

func WithTTL

func WithTTL(val time.Duration) Option

func WithValue2Key

func WithValue2Key() Option