cache

Documentation

Index

• type Cacheable
• type State
  • func Get(key string, decodeTo interface{}) State
  • func Store(key string, lifetime time.Duration, data interface{}) State

Types

type Cacheable

type Cacheable struct {
	Expires  lib.JSONTime `json:"_expires"`
	Contents interface{}  `json":contents"`
}

Cacheable defines metadata for objects which can be cached to files as JSON

type State

type State int

State defines the return of the Store and Get calls

const (
	// CacheFound means the key was found and valid
	CacheFound State = iota
	// CacheExpired means the key was found, but has expired. The value returned is not valid.
	CacheExpired
	// CacheNoEntry means the key was not found.
	CacheNoEntry
	// CacheNotAvailable means the cache system is not working as expected and has an internal error
	CacheNotAvailable
)

func Get

func Get(key string, decodeTo interface{}) State

Get gets a key from the named cache file

func Store

func Store(key string, lifetime time.Duration, data interface{}) State

Store stores the given data interface as a JSON file with a given expiration time under the given key.