cache

Documentation

Index

• Variables
• type Cache
  • func ConstCache(data []byte) Cache
  • func FileCache(dirname string) Cache
  • func FileCacheWithFormat(dirname string, format string) Cache
  • func FileCacheWithNameFn(dirname string, filename func(string) string) Cache
  • func MemoryCache() Cache
  • func WriteTroughCache(dirname string) Cache
  • func WriteTroughCacheWithFormat(dirname, format string) Cache
  • func WriteTroughCacheWithNameFn(dirname string, fn func(string) string) Cache

Variables

var EmptyCache = &emptyCache{}

EmptyCache represents a cache that never stores anything

Types

type Cache

type Cache interface {
	// Get gets the data, returning nil if it isn't cached
	Get(key string) ([]byte, error)

	// Set saves data,
	Set(key string, data []byte) error
}

Cache represents a cache

func ConstCache

func ConstCache(data []byte) Cache

ConstCache creates a Cache that always returns the same data

func FileCache

func FileCache(dirname string) Cache

FileCache returns a cache that stores keys on filesystem

func FileCacheWithFormat

func FileCacheWithFormat(dirname string, format string) Cache

FileCacheWithFormat creates a FileCache that uses a format string to generate filenames

func FileCacheWithNameFn

func FileCacheWithNameFn(dirname string, filename func(string) string) Cache

FileCacheWithNameFn creates a FileCache that has a custom function to generate filenames

func MemoryCache

func MemoryCache() Cache

MemoryCache returns a cache that stores keys in memory

func WriteTroughCache

func WriteTroughCache(dirname string) Cache

WriteTroughCache creates a cache that stores keys in memory and uses disk as fallback

func WriteTroughCacheWithFormat

func WriteTroughCacheWithFormat(dirname, format string) Cache

WriteTroughCacheWithFormat creates a cache that stores keys in memory and uses disk as fallback and that generates filenames based on the format

func WriteTroughCacheWithNameFn

func WriteTroughCacheWithNameFn(dirname string, fn func(string) string) Cache

WriteTroughCacheWithNameFn creates a cache that stores keys in memory and uses disk as fallback. It generates filenames based on the passed in function.