cache

Documentation

Index

• func AddToHash(h uint64, in ...interface{}) uint64
• func InitHash(t uint64) uint64
• func NewHash(t uint64, in ...interface{}) uint64
• type Cache
  • func NewCache() *Cache
  • func NewCacheWithCapacity(capacity int) (*Cache, error)
  • func (c *Cache) Clear()
  • func (c *Cache) Read(h Hashable) (string, bool)
  • func (c *Cache) ReadRaw(h Hashable) (interface{}, bool)
  • func (c *Cache) Write(h Hashable, value interface{})
• type HasOnEvict
• type Hashable
  • func NewHashable(t uint64, v interface{}) Hashable

Functions

func AddToHash

func AddToHash(h uint64, in ...interface{}) uint64

func InitHash

func InitHash(t uint64) uint64

func NewHash

func NewHash(t uint64, in ...interface{}) uint64

Types

type Cache

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

Cache holds a map of volatile key -> values.

func NewCache

func NewCache() *Cache

NewCache initializes a new caching space with default settings.

func NewCacheWithCapacity

func NewCacheWithCapacity(capacity int) (*Cache, error)

NewCacheWithCapacity initializes a new caching space with the given capacity.

func (*Cache) Clear

func (c *Cache) Clear()

Clear generates a new memory space, leaving the old memory unreferenced, so it can be claimed by the garbage collector.

func (*Cache) Read

func (c *Cache) Read(h Hashable) (string, bool)

Read attempts to retrieve a cached value as a string, if the value does not exists returns an empty string and false.

func (*Cache) ReadRaw

func (c *Cache) ReadRaw(h Hashable) (interface{}, bool)

ReadRaw attempts to retrieve a cached value as an interface{}, if the value does not exists returns nil and false.

func (*Cache) Write

func (c *Cache) Write(h Hashable, value interface{})

Write stores a value in memory. If the value already exists its overwritten.

type HasOnEvict

type HasOnEvict interface {
	OnEvict()
}

HasOnEvict type is (optionally) implemented by cache objects to clean after themselves.

type Hashable

type Hashable interface {
	Hash() uint64
}

Hashable types must implement a method that returns a key. This key will be associated with a cached value.

func NewHashable

func NewHashable(t uint64, v interface{}) Hashable