cache

Documentation

Index

• type Cache
  • func New[T Cacheable](_ T, filePath string, savePeriod time.Duration) *Cache[T]
  • func (c *Cache[T]) Close()
  • func (c *Cache[T]) Get(key string) (T, bool)
  • func (c *Cache[T]) Items() []Entry[T]
  • func (c *Cache[T]) Purge()
  • func (c *Cache[T]) Remove(key string)
  • func (c *Cache[T]) Save() error
  • func (c *Cache[T]) Set(key string, value T)
• type Cacheable
• type Entry
• type Expirable
  • func (e *Expirable) Age(t ...time.Time) uint32
  • func (e *Expirable) RemainingTTL(t ...time.Time) uint32

Types

type Cache

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

func New

func New[T Cacheable](_ T, filePath string, savePeriod time.Duration) *Cache[T]

func (*Cache[T]) Close

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

func (*Cache[T]) Get

func (c *Cache[T]) Get(key string) (T, bool)

func (*Cache[T]) Items

func (c *Cache[T]) Items() []Entry[T]

func (*Cache[T]) Purge

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

func (*Cache[T]) Remove

func (c *Cache[T]) Remove(key string)

func (*Cache[T]) Save

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

func (*Cache[T]) Set

func (c *Cache[T]) Set(key string, value T)

type Cacheable

type Cacheable interface {
	RemainingTTL(...time.Time) uint32
	Age(...time.Time) uint32
}

type Entry

type Entry[T Cacheable] struct {
	Value T
	Key   string
}

type Expirable

type Expirable struct {
	ExpiresAt  time.Time
	LastUpdate time.Time
}

func (*Expirable) Age

func (e *Expirable) Age(t ...time.Time) uint32

func (*Expirable) RemainingTTL

func (e *Expirable) RemainingTTL(t ...time.Time) uint32