cache

Documentation

Index

• type Cache
  • func New[K Key, V Value](opts Opts) *Cache[K, V]
  • func (c *Cache[K, V]) Close() error
  • func (c *Cache[K, V]) Flush()
  • func (c *Cache[K, V]) Get(key K) (v V, expirationTime time.Time, ok bool)
  • func (c *Cache[K, V]) Len() int
  • func (c *Cache[K, V]) Range(f func(key K, v V, expirationTime time.Time) error) error
  • func (c *Cache[K, V]) Store(key K, v V, expirationTime time.Time)
• type Key
• type Opts
• type Value

Types

type Cache

type Cache[K Key, V Value] struct {
	// contains filtered or unexported fields
}

Cache is a simple map cache that stores values in memory. It is safe for concurrent use.

func New

func New[K Key, V Value](opts Opts) *Cache[K, V]

New initializes a Cache. The minimum size is 1024. cleanerInterval specifies the interval that Cache scans and discards expired values. If cleanerInterval <= 0, a default interval will be used.

func (*Cache[K, V]) Close

func (c *Cache[K, V]) Close() error

Close closes the inner cleaner of this cache.

func (*Cache[K, V]) Flush

func (c *Cache[K, V]) Flush()

Flush removes all stored entries from this cache.

func (*Cache[K, V]) Get

func (c *Cache[K, V]) Get(key K) (v V, expirationTime time.Time, ok bool)

func (*Cache[K, V]) Len

func (c *Cache[K, V]) Len() int

Len returns the current size of this cache.

func (*Cache[K, V]) Range

func (c *Cache[K, V]) Range(f func(key K, v V, expirationTime time.Time) error) error

Range calls f through all entries. If f returns an error, the same error will be returned by Range.

func (*Cache[K, V]) Store

func (c *Cache[K, V]) Store(key K, v V, expirationTime time.Time)

Store stores this kv in cache. If expirationTime is before time.Now(), Store is an noop.

type Key

type Key interface {
	concurrent_lru.Hashable
}

type Opts

type Opts struct {
	Size            int
	CleanerInterval time.Duration
}

type Value

type Value interface {
	any
}