cache

Documentation

Overview

Package cache manages CLI cache files in the XDG cache directory.

The cache stores metadata about the registry index (version and fetch timestamp) so that commands can reuse a known-good canonical version without a network call. The actual index data is cached by CUE's module cache; this package only tracks which version was last fetched and when.

Index

• Constants
• func Dir() (string, error)
• func WriteIndex(version string) error
• type IndexCache
  • func ReadIndex() (IndexCache, error)
  • func (c IndexCache) IsFresh(maxAge time.Duration) bool

Constants

const (

	// DefaultMaxAge is the default staleness threshold for the index cache.
	DefaultMaxAge = 24 * time.Hour
)

Functions

func Dir

func Dir() (string, error)

Dir returns the cache directory path, respecting XDG_CACHE_HOME.

func WriteIndex

func WriteIndex(version string) error

WriteIndex writes the index version and current timestamp to the cache file. Creates the cache directory if needed. Errors are returned but callers should treat them as non-fatal (best-effort).

Types

type IndexCache

type IndexCache struct {
	Updated time.Time
	Version string
}

IndexCache holds the cached registry index metadata.

func ReadIndex

func ReadIndex() (IndexCache, error)

ReadIndex reads the index cache from disk. Returns an error if the file is missing or malformed.

func (IndexCache) IsFresh

func (c IndexCache) IsFresh(maxAge time.Duration) bool

IsFresh returns true if the cache was updated within maxAge.