cache

package

v0.3.0 Latest Latest Go to latest Published: Jun 10, 2026 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/UnitVectorY-Labs/gogitup

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func DefaultPath() string
func IsExpired(entry Entry, ttl time.Duration) bool
func Remove(c *Cache, name string)
func Save(path string, c *Cache) error
func Set(c *Cache, name string, version string)
func SetForInstalledVersion(c *Cache, name, installedVersion, latestVersion string)
type Cache
- func Load(path string) (*Cache, error)
type Entry
- func Get(c *Cache, name string) (Entry, bool)

Constants ¶

View Source

const DefaultTTL = 24 * time.Hour

DefaultTTL is the default time-to-live for cache entries.

Variables ¶

This section is empty.

Functions ¶

func DefaultPath ¶

func DefaultPath() string

DefaultPath returns the default cache file path (~/.gogitup.cache).

func IsExpired ¶

func IsExpired(entry Entry, ttl time.Duration) bool

IsExpired checks if a cache entry is older than the given TTL.

func Remove ¶

func Remove(c *Cache, name string)

Remove removes the cache entry for the given app name.

func Save ¶

func Save(path string, c *Cache) error

Save writes the cache to the given file path.

func Set ¶

func Set(c *Cache, name string, version string)

Set sets the cache entry for the given app name with the current time.

func SetForInstalledVersion ¶ added in v0.3.0

func SetForInstalledVersion(c *Cache, name, installedVersion, latestVersion string)

SetForInstalledVersion caches a version check for a specific installed version.

Types ¶

type Cache ¶

type Cache struct {
	Entries map[string]Entry `yaml:"entries"`
}

Cache represents the gogitup cache file.

func Load ¶

func Load(path string) (*Cache, error)

Load reads and parses the cache file at the given path. If the file does not exist, an empty Cache is returned without error.

type Entry ¶

type Entry struct {
	LatestVersion    string    `yaml:"latest_version"`
	InstalledVersion string    `yaml:"installed_version,omitempty"`
	CheckedAt        time.Time `yaml:"checked_at"`
}

Entry represents a cached version check result for an application.

func Get ¶

func Get(c *Cache, name string) (Entry, bool)

Get returns the cache entry for the given app name and whether it was found.

Source Files ¶

View all Source files

cache.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL