cache

Documentation

Overview

Package cache is the content-addressed cache of fetched source material, enabling offline reproduction from a warm cache.

Index

• type Cache
  • func New(root string) *Cache
  • func (c *Cache) Has(key string) bool
  • func (c *Cache) Path(key string) string
  • func (c *Cache) Put(key, srcDir string) (string, error)
  • func (c *Cache) Root() string

Types

type Cache

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

Cache is the content-addressed cache of fetched source material, keyed by an immutable fetch key (typically a commit SHA). A warm cache enables offline reproduction (FR-025, FR-026).

func New

func New(root string) *Cache

New returns a Cache rooted at root.

func (*Cache) Has

func (c *Cache) Has(key string) bool

Has reports whether material for key is cached.

func (*Cache) Path

func (c *Cache) Path(key string) string

Path returns the directory for a fetch key, whether or not it exists.

func (*Cache) Put

func (c *Cache) Put(key, srcDir string) (string, error)

Put imports fetched material from srcDir under key and returns the cached path. It is idempotent, so a warm entry is reused rather than refetched.

func (*Cache) Root

func (c *Cache) Root() string

Root returns the cache's root directory.