cache

Documentation

Index

• Variables
• type Cache
  • func NewFSCache(root string) (Cache, error)
• type FSCache
  • func (fs *FSCache) Delete(key string) error
  • func (fs *FSCache) Get(key string) ([]byte, error)
  • func (fs *FSCache) Keys() ([]string, error)
  • func (fs *FSCache) Set(key string, content []byte) error
  • func (fs *FSCache) Setup() error

Variables

var (
	// ErrNoSuchKey is returned when a key is not found
	ErrNoSuchKey = errors.New("no such key")
)

Types

type Cache

type Cache interface {
	Get(string) ([]byte, error)
	Set(string, []byte) error
	Keys() ([]string, error)
	Delete(string) error
}

Cache is the interface that

func NewFSCache

func NewFSCache(root string) (Cache, error)

NewFSCache returns a FileSystemcache with defaults set, and makes sure that the FSCache has a directory to store info in.

type FSCache

type FSCache struct {
	Root string
}

FSCache is an implementation of Cache that stores information in the filesystem

func (*FSCache) Delete

func (fs *FSCache) Delete(key string) error

Delete removes a key or returns ErrNoSuchKey

func (*FSCache) Get

func (fs *FSCache) Get(key string) ([]byte, error)

Get returns the content under key or ErrNoSuchKey

func (*FSCache) Keys

func (fs *FSCache) Keys() ([]string, error)

Keys returns the keys managed by this cache

func (*FSCache) Set

func (fs *FSCache) Set(key string, content []byte) error

Set writes the content under the given key

func (*FSCache) Setup

func (fs *FSCache) Setup() error

Setup creates the directory for storage, if it doesn't exist