filecache

Documentation

Index

• type Cache
  • func New[T any](cap int, ttl time.Duration) *Cache[T]
  • func (c *Cache[T]) Entry(fileName string) Entry[T]
  • func (c *Cache[T]) Invalidate(fileName string)
  • func (*Cache[T]) IsStale(fileName string, entry Entry[T]) (bool, os.FileInfo, error)
  • func (c *Cache[T]) Load(fileName string) (T, bool)
  • func (c *Cache[T]) LoadLatest(fileName string, loader func() (T, error)) (T, error)
  • func (c *Cache[T]) StartEviction()
  • func (c *Cache[T]) Stop()
  • func (c *Cache[T]) StopEviction()
  • func (c *Cache[T]) Store(fileName string, data T, fi os.FileInfo)
• type Entry

Types

type Cache

type Cache[T any] struct {
	// contains filtered or unexported fields
}

TODO: Consider replacing this with golang-lru: https://github.com/hashicorp/golang-lru

func New

func New[T any](cap int, ttl time.Duration) *Cache[T]

func (*Cache[T]) Entry

func (c *Cache[T]) Entry(fileName string) Entry[T]

func (*Cache[T]) Invalidate

func (c *Cache[T]) Invalidate(fileName string)

func (*Cache[T]) IsStale

func (*Cache[T]) IsStale(
	fileName string, entry Entry[T],
) (bool, os.FileInfo, error)

func (*Cache[T]) Load

func (c *Cache[T]) Load(fileName string) (T, bool)

func (*Cache[T]) LoadLatest

func (c *Cache[T]) LoadLatest(
	fileName string, loader func() (T, error),
) (T, error)

func (*Cache[T]) StartEviction

func (c *Cache[T]) StartEviction()

func (*Cache[T]) Stop

func (c *Cache[T]) Stop()

func (*Cache[T]) StopEviction

func (c *Cache[T]) StopEviction()

func (*Cache[T]) Store

func (c *Cache[T]) Store(fileName string, data T, fi os.FileInfo)

type Entry

type Entry[T any] struct {
	Data         T
	Size         int64
	LastModified int64
	ExpiresAt    time.Time
}