cache

Documentation

Overview

Package cache provides a lightweight engine for storing key/value pairs.

Index

• Constants
• type Cache
  • func (c Cache) Delete(id string) error
  • func (c Cache) Path() (string, error)
  • func (c Cache) Read(id string) (string, error)
  • func (c Cache) String() string
  • func (c Cache) Write(key, value string, ttl time.Duration) error
  • func (c Cache) WriteNoExpire(key, value string) error

Constants

const (
	DirMode   = 0o755              // Directory permissions.
	ExpiredAt = 7 * 24 * time.Hour // The expiry time for storage engine entries.
	SubDir    = "cacheDB"          // The name of the storage engine subdirectory.
)

Types

type Cache

type Cache int // Cache is the type of storage engine.

const (
	Pouet Cache = iota // data cache for the Pouet website, API requests
	Test               // test cache
)

func (Cache) Delete

func (c Cache) Delete(id string) error

Delete deletes a key/value pair from the storage engine.

func (Cache) Path

func (c Cache) Path() (string, error)

Path returns the absolute path to the storage engine directory. If the directory does not exist it will be created.

func (Cache) Read

func (c Cache) Read(id string) (string, error)

Read returns value from the storage engine.

func (Cache) String

func (c Cache) String() string

String returns the name of the cache.

func (Cache) Write

func (c Cache) Write(key, value string, ttl time.Duration) error

Write writes a key/value pair to the storage engine. The key/value pair will be deleted after the ttl time duration has elapsed. If ttl is 0 then the key/value pair will immediately expire.

func (Cache) WriteNoExpire

func (c Cache) WriteNoExpire(key, value string) error

WriteNoExpire writes a key/value pair to the storage engine. The key/value pair will not expire.