cache

Documentation

Overview

Package cache provides functionality for managing a cache located on the file system.

Index

• type Cache
  • func New(location string, ephemeral bool) (Cache, error)
  • func (c *Cache) Cleanup()
  • func (c *Cache) Clear() error
  • func (c *Cache) Init() error
  • func (c *Cache) Path() string

Types

type Cache

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

Cache represents a cache located on the file system.

func New

func New(location string, ephemeral bool) (Cache, error)

New creates an uninitialized cache.

If location is an empty string the location will default to the user's home directory.

If ephemeral is set the cache will be located in a unique directory in the system's temporary directory (and the given location is ignored).

func (*Cache) Cleanup

func (c *Cache) Cleanup()

Cleanup removes the cache if it is ephemeral, ignoring errors.

func (*Cache) Clear

func (c *Cache) Clear() error

Clear removes the contents of the cache.

func (*Cache) Init

func (c *Cache) Init() error

Init sets up the cache (if necessary).

func (*Cache) Path

func (c *Cache) Path() string

Path returns the path to the cache on the file system.