cache

Documentation

Overview

Package cache implements a simple cache where the entries are expired after a given time (5 minutes of disuse by default).

Index

• type Cache
  • func New() *Cache
  • func (c *Cache) Clear()
  • func (c *Cache) Delete(key string) bool
  • func (c *Cache) DeletePrefix(prefix string) (deleted int)
  • func (c *Cache) Entries() int
  • func (c *Cache) Get(key string, create CreateFunc) (value interface{}, err error)
  • func (c *Cache) GetMaybe(key string) (value interface{}, found bool)
  • func (c *Cache) Pin(key string)
  • func (c *Cache) Put(key string, value interface{})
  • func (c *Cache) Rename(oldKey, newKey string) (value interface{}, found bool)
  • func (c *Cache) SetExpireDuration(d time.Duration) *Cache
  • func (c *Cache) SetExpireInterval(d time.Duration) *Cache
  • func (c *Cache) SetFinalizer(finalize func(interface{}))
  • func (c *Cache) Unpin(key string)
• type CreateFunc

Types

type Cache

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

Cache holds values indexed by string, but expired after a given (5 minutes by default).

func New

func New() *Cache

New creates a new cache with the default expire duration and interval

func (*Cache) Clear

func (c *Cache) Clear()

Clear removes everything from the cache

func (*Cache) Delete

func (c *Cache) Delete(key string) bool

Delete the entry passed in

Returns true if the entry was found

func (*Cache) DeletePrefix

func (c *Cache) DeletePrefix(prefix string) (deleted int)

DeletePrefix deletes all entries with the given prefix

Returns number of entries deleted

func (*Cache) Entries

func (c *Cache) Entries() int

Entries returns the number of entries in the cache

func (*Cache) Get

func (c *Cache) Get(key string, create CreateFunc) (value interface{}, err error)

Get gets a value named key either from the cache or creates it afresh with the create function.

func (*Cache) GetMaybe

func (c *Cache) GetMaybe(key string) (value interface{}, found bool)

GetMaybe returns the key and true if found, nil and false if not

func (*Cache) Pin

func (c *Cache) Pin(key string)

Pin a value in the cache if it exists

func (*Cache) Put

func (c *Cache) Put(key string, value interface{})

Put puts a value named key into the cache

func (*Cache) Rename

func (c *Cache) Rename(oldKey, newKey string) (value interface{}, found bool)

Rename renames the item at oldKey to newKey.

If there was an existing item at newKey then it takes precedence and is returned otherwise the item (if any) at oldKey is returned.

func (*Cache) SetExpireDuration

func (c *Cache) SetExpireDuration(d time.Duration) *Cache

SetExpireDuration sets the interval at which things expire

If it is less than or equal to 0 then things are never cached

func (*Cache) SetExpireInterval

func (c *Cache) SetExpireInterval(d time.Duration) *Cache

SetExpireInterval sets the interval at which the cache expiry runs

Set to 0 or a -ve number to disable

func (*Cache) SetFinalizer

func (c *Cache) SetFinalizer(finalize func(interface{}))

SetFinalizer sets a function to be called when a value drops out of the cache

func (*Cache) Unpin

func (c *Cache) Unpin(key string)

Unpin a value in the cache if it exists

type CreateFunc

type CreateFunc func(key string) (value interface{}, ok bool, error error)

CreateFunc is called to create new values. If the create function returns an error it will be cached if ok is true, otherwise the error will just be returned, allowing negative caching if required.