workingsetcache

Documentation

Index

• type Cache
  • func Load(filePath string, maxBytes int) *Cache
  • func LoadWithExpire(filePath string, maxBytes int, expireDuration time.Duration) *Cache
  • func New(maxBytes int) *Cache
  • func NewWithExpire(maxBytes int, expireDuration time.Duration) *Cache
  • func (c *Cache) Get(dst, key []byte) []byte
  • func (c *Cache) GetBig(dst, key []byte) []byte
  • func (c *Cache) Has(key []byte) bool
  • func (c *Cache) Reset()
  • func (c *Cache) Save(filePath string) error
  • func (c *Cache) Set(key, value []byte)
  • func (c *Cache) SetBig(key, value []byte)
  • func (c *Cache) Stop()
  • func (c *Cache) UpdateStats(fcs *fastcache.Stats)

Types

type Cache

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

Cache is a cache for working set entries.

The cache evicts inactive entries after the given expireDuration. Recently accessed entries survive expireDuration.

func Load

func Load(filePath string, maxBytes int) *Cache

Load loads the cache from filePath and limits its size to maxBytes and evicts inactive entries in 20 minutes.

Stop must be called on the returned cache when it is no longer needed.

func LoadWithExpire

func LoadWithExpire(filePath string, maxBytes int, expireDuration time.Duration) *Cache

LoadWithExpire loads the cache from filePath and limits its size to maxBytes and evicts inactive entires after expireDuration.

Stop must be called on the returned cache when it is no longer needed.

func New

func New(maxBytes int) *Cache

New creates new cache with the given maxBytes capacity.

Stop must be called on the returned cache when it is no longer needed.

func NewWithExpire

func NewWithExpire(maxBytes int, expireDuration time.Duration) *Cache

NewWithExpire creates new cache with the given maxBytes capacity and the given expireDuration for inactive entries.

Stop must be called on the returned cache when it is no longer needed.

func (*Cache) Get

func (c *Cache) Get(dst, key []byte) []byte

Get appends the found value for the given key to dst and returns the result.

func (*Cache) GetBig

func (c *Cache) GetBig(dst, key []byte) []byte

GetBig appends the found value for the given key to dst and returns the result.

func (*Cache) Has

func (c *Cache) Has(key []byte) bool

Has verifies whether the cache contains the given key.

func (*Cache) Reset

func (c *Cache) Reset()

Reset resets the cache.

func (*Cache) Save

func (c *Cache) Save(filePath string) error

Save saves the cache to filePath.

func (*Cache) Set

func (c *Cache) Set(key, value []byte)

Set sets the given value for the given key.

func (*Cache) SetBig

func (c *Cache) SetBig(key, value []byte)

SetBig sets the given value for the given key.

func (*Cache) Stop

func (c *Cache) Stop()

Stop stops the cache.

The cache cannot be used after the Stop call.

func (*Cache) UpdateStats

func (c *Cache) UpdateStats(fcs *fastcache.Stats)

UpdateStats updates fcs with cache stats.