cache

Documentation

Overview

Package cache implements a simple file-based cache.

Index

• type Cache
  • func Create(name string) (*Cache, error)
  • func Disabled() *Cache
  • func (c *Cache) Read(name string) ([]byte, time.Time, error)
  • func (c *Cache) Write(name string, data []byte) error

Types

type Cache

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

A Cache is a directory holding cached data.

func Create

func Create(name string) (*Cache, error)

Create returns a cache using the named subdirectory of the user's cache directory. For example, on macOS, Create("myprog") uses $HOME/Library/Caches/myprog. Create creates the directory if it does not already exist.

func Disabled

func Disabled() *Cache

Disabled returns a Cache that is always empty. Reads always return no result, and writes succeed but are discarded.

func (*Cache) Read

func (c *Cache) Read(name string) ([]byte, time.Time, error)

Read reads the file with the given name in the cache. It returns the file content, its last modification time, and any error encountered. If the file does not exist in the cache, Read returns nil, time.Time{}, nil.

func (*Cache) Write

func (c *Cache) Write(name string, data []byte) error

Write writes data to the file with the given name in the cache.