diskcache

package module

v0.2.4 Latest Latest Go to latest Published: Jul 14, 2020 License: AGPL-3.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

This section is empty.

This section is empty.

func ByteCountIEC(b int) string

ByteCountIEC returns a human-readable string describing the size of bytes in int

func GetCacheKey(key string) (string, string)

type ByTimestamp []KeyPair

ByTimestamp is a sortable slice of KeyPair based off timestamp

func (a ByTimestamp) Len() int

func (a ByTimestamp) Less(i, j int) bool

func (a ByTimestamp) Swap(i, j int)

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

Cache is a struct that represents a cache object

func New(directory string, cacheLimit int, cacheScanInterval int, maxCacheScanTime int) *Cache

New returns a new Cache that will store files in basePath

func (c *Cache) Close()

func (c *Cache) DeleteFile(file string)

DeleteFile takes an absolute path to a file and deletes it

func (c *Cache) Get(key string) (resp []byte, ok bool)

Get takes a key, hashes it, and returns the corresponding file in the directory

func (c *Cache) Set(key string, resp []byte)

Set takes a key, hashes it, and saves the `resp` bytearray into the corresponding file

func (c *Cache) StartBackgroundThread()

StartBackgroundThread starts a background thread that automatically scans the directory and removes older files when cache exceeds size limits

func (c *Cache) UpdateCacheLimit(cacheLimit int)

func (c *Cache) UpdateCacheScanInterval(cacheScanInterval int)

type KeyPair struct {
	Key       string
	Timestamp int64
	Size      int
}

KeyPair is a struct that represents a cache key in database

func (a *KeyPair) UpdateTimestamp()