cache

package
v0.0.0-...-4d2c057 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 7, 2019 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	TYPE_SIMPLE = "simple"
	TYPE_LRU    = "lru"
	TYPE_LFU    = "lfu"
)

Variables

View Source 
var KeyNotFoundError = errors.New("Key not found.")

Functions

This section is empty.

Types

type AddedFunc 

type AddedFunc func(interface{}, interface{})

type Cache 

type Cache interface {
	Set(interface{}, interface{}) error
	SetWithExpire(interface{}, interface{}, time.Duration) error
	Get(interface{}) (interface{}, error)
	GetIFPresent(interface{}) (interface{}, error)
	GetALL() map[interface{}]interface{}

	Remove(interface{}) bool
	Purge()
	Keys() []interface{}
	Len() int
	// contains filtered or unexported methods
}

Cache operations

type CacheBuilder 

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

func New 

func New(size int) *CacheBuilder

func (*CacheBuilder) AddedFunc 

func (cb *CacheBuilder) AddedFunc(addedFunc AddedFunc) *CacheBuilder

func (*CacheBuilder) Build 

func (cb *CacheBuilder) Build() Cache

func (*CacheBuilder) Clock 

func (cb *CacheBuilder) Clock(clock Clock) *CacheBuilder

func (*CacheBuilder) DeserializeFunc 

func (cb *CacheBuilder) DeserializeFunc(deserializeFunc DeserializeFunc) *CacheBuilder

func (*CacheBuilder) EvictType 

func (cb *CacheBuilder) EvictType(tp string) *CacheBuilder

func (*CacheBuilder) EvictedFunc 

func (cb *CacheBuilder) EvictedFunc(evictedFunc EvictedFunc) *CacheBuilder

func (*CacheBuilder) Expiration 

func (cb *CacheBuilder) Expiration(expiration time.Duration) *CacheBuilder

func (*CacheBuilder) LFU 

func (cb *CacheBuilder) LFU() *CacheBuilder

func (*CacheBuilder) LRU 

func (cb *CacheBuilder) LRU() *CacheBuilder

func (*CacheBuilder) LoaderExpireFunc 

func (cb *CacheBuilder) LoaderExpireFunc(loaderExpireFunc LoaderExpireFunc) *CacheBuilder

Set a loader function with expiration.

func (*CacheBuilder) LoaderFunc 

func (cb *CacheBuilder) LoaderFunc(loaderFunc LoaderFunc) *CacheBuilder

LoaderFunc: create a new value with this function if cached value is expired.

func (*CacheBuilder) SerializeFunc 

func (cb *CacheBuilder) SerializeFunc(serializeFunc SerializeFunc) *CacheBuilder

func (*CacheBuilder) Simple 

func (cb *CacheBuilder) Simple() *CacheBuilder

type Clock 

type Clock interface {
	Now() time.Time
}

func NewRealClock 

func NewRealClock() Clock

type DeserializeFunc 

type DeserializeFunc func(interface{}, interface{}) (interface{}, error)

type EvictedFunc 

type EvictedFunc func(interface{}, interface{})

type Group 

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

Group represents a class of work

func (*Group) Do 

func (g *Group) Do(key interface{}, fn func() (interface{}, error), isWait bool) (interface{}, bool, error)

Do executes and returns the results of the given function

type LFUCache 

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

Discards the least frequently used items first.

func (*LFUCache) Get 

func (c *LFUCache) Get(key interface{}) (interface{}, error)

Get a value from cache pool using key if it exists.

func (*LFUCache) GetALL 

func (c *LFUCache) GetALL() map[interface{}]interface{}

Returns all key-value pairs in the cache.

func (*LFUCache) GetIFPresent 

func (c *LFUCache) GetIFPresent(key interface{}) (interface{}, error)

Get a value from cache pool using key if it exists.

func (*LFUCache) Keys 

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

Returns a slice of the keys in the cache.

func (*LFUCache) Len 

func (c *LFUCache) Len() int

Returns the number of items in the cache.

func (*LFUCache) Purge 

func (c *LFUCache) Purge()

Completely clear the cache

func (*LFUCache) Remove 

func (c *LFUCache) Remove(key interface{}) bool

Removes the provided key from the cache.

func (*LFUCache) Set 

func (c *LFUCache) Set(key, value interface{}) error

Set a new key-value pair

func (*LFUCache) SetWithExpire 

func (c *LFUCache) SetWithExpire(key, value interface{}, expiration time.Duration) error

Set a new key-value pair with an expiration time

type LRUCache 

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

LRUCache

func (*LRUCache) Get 

func (c *LRUCache) Get(key interface{}) (interface{}, error)

Get a value from cache pool using key if it exists.

func (*LRUCache) GetALL 

func (c *LRUCache) GetALL() map[interface{}]interface{}

Returns all key-value pairs in the cache.

func (*LRUCache) GetIFPresent 

func (c *LRUCache) GetIFPresent(key interface{}) (interface{}, error)

Get a value from cache pool using key if it exists.

func (*LRUCache) Keys 

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

Returns a slice of the keys in the cache.

func (*LRUCache) Len 

func (c *LRUCache) Len() int

Returns the number of items in the cache.

func (*LRUCache) Purge 

func (c *LRUCache) Purge()

Completely clear the cache

func (*LRUCache) Remove 

func (c *LRUCache) Remove(key interface{}) bool

Removes the provided key from the cache.

func (*LRUCache) Set 

func (c *LRUCache) Set(key, value interface{}) error

set a new key-value pair

func (*LRUCache) SetWithExpire 

func (c *LRUCache) SetWithExpire(key, value interface{}, expiration time.Duration) error

Set a new key-value pair with an expiration time

type LoaderExpireFunc 

type LoaderExpireFunc func(interface{}) (interface{}, *time.Duration, error)

type LoaderFunc 

type LoaderFunc func(interface{}) (interface{}, error)

type RealClock 

type RealClock struct{}

func (RealClock) Now 

func (rc RealClock) Now() time.Time

type SerializeFunc 

type SerializeFunc func(interface{}, interface{}) (interface{}, error)

type SimpleCache 

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

func (*SimpleCache) Get 

func (c *SimpleCache) Get(key interface{}) (interface{}, error)

Get a value from cache pool using key if it exists.

func (*SimpleCache) GetALL 

func (c *SimpleCache) GetALL() map[interface{}]interface{}

Returns all key-value pairs in the cache.

func (*SimpleCache) GetIFPresent 

func (c *SimpleCache) GetIFPresent(key interface{}) (interface{}, error)

Get a value from cache pool using key if it exists.

func (*SimpleCache) Keys 

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

Returns a slice of the keys in the cache.

func (*SimpleCache) Len 

func (c *SimpleCache) Len() int

Returns the number of items in the cache.

func (*SimpleCache) Purge 

func (c *SimpleCache) Purge()

Completely clear the cache

func (*SimpleCache) Remove 

func (c *SimpleCache) Remove(key interface{}) bool

Removes the provided key from the cache.

func (*SimpleCache) Set 

func (c *SimpleCache) Set(key, value interface{}) error

Set a new key-value pair

func (*SimpleCache) SetWithExpire 

func (c *SimpleCache) SetWithExpire(key, value interface{}, expiration time.Duration) error

Set a new key-value pair with an expiration time

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.