cache

Documentation

Index

• Variables
• func IsExpired(expire time.Time, now *time.Time) bool
• type Cache
  • func New[T any](path string) *Cache[T]
  • func (c *Cache[T]) Add(name string, data any) error
  • func (c *Cache[T]) Clear() error
  • func (c *Cache[T]) Get(name string) (*T, error)
  • func (c *Cache[T]) List() ([]Saved[T], error)
• type Saved

Variables

var (
	ErrorUnableToMarshalJSON        = errors.New("unable to marshal as JSON")
	ErrorUnableToEnsureCacheDir     = errors.New("unable to ensure cache-dir is present")
	ErrorUnableToWriteCache         = errors.New("unable to write data to cache file")
	ErrorUnableToOpenCacheFile      = errors.New("unable to open cache")
	ErrorUnableToReadCacheFile      = errors.New("unable to read cache")
	ErrorUnableToUnmarshalCacheFile = errors.New("unable to unmarshal JSON from cache-file")
	ErrorUnableToReadCachePath      = errors.New("unable to read from cache path")
)

Functions

func IsExpired

func IsExpired(expire time.Time, now *time.Time) bool

Returns if t is expired

Types

type Cache

type Cache[T any] struct {
	Path string
}

func New

func New[T any](path string) *Cache[T]

New Cache where default path is os.TempDir()

func (*Cache[T]) Add

func (c *Cache[T]) Add(name string, data any) error

Add data as JSON-file into cache-dir, returns nil if success

func (*Cache[T]) Clear

func (c *Cache[T]) Clear() error

func (*Cache[T]) Get

func (c *Cache[T]) Get(name string) (*T, error)

Get data from JSON-file from cache-dir, returns nil if no result

func (*Cache[T]) List

func (c *Cache[T]) List() ([]Saved[T], error)

type Saved

type Saved[T any] struct {
	Filename string
	Item     T
}