cache

Documentation

Index

• Variables
• type Cache
  • func NewCache[K comparable, V any](opt ...Option) Cache[K, V]
• type EvictCallback
• type LruCache
  • func (c *LruCache[K, V]) Contains(key K) bool
  • func (c *LruCache[K, V]) Delete(key K)
  • func (c *LruCache[K, V]) Get(key K) (value V, err error)
  • func (c *LruCache[K, V]) Set(key K, value V)
  • func (c *LruCache[K, V]) Stop()
• type Option
  • func WithBackgroundCheckCache() Option
  • func WithDeleteExpiredCacheOnGet() Option
  • func WithEvictCallback(fn EvictCallback) Option
  • func WithExpiration(expiration time.Duration) Option
  • func WithGoTimeNow() Option
  • func WithInterval(interval time.Duration) Option
  • func WithMaxSize(maxSize int) Option
  • func WithUpdateCacheExpirationOnGet() Option
• type OptionFunc

Variables

var (
	ErrCacheIsNotFound = errors.New("cache is not found")
	ErrCacheWasExpired = errors.New("cache was expired")
)

var DefaultUpdateTimeTickInterval = time.Millisecond * 300

Types

type Cache

type Cache[K comparable, V any] interface {
	Get(K) (V, error)
	Set(K, V)
	Delete(K)
	Contains(K) bool
	Stop()
}

func NewCache

func NewCache[K comparable, V any](opt ...Option) Cache[K, V]

type EvictCallback

type EvictCallback func(any, any)

type LruCache

type LruCache[K comparable, V any] struct {
	// contains filtered or unexported fields
}

func (*LruCache[K, V]) Contains

func (c *LruCache[K, V]) Contains(key K) bool

func (*LruCache[K, V]) Delete

func (c *LruCache[K, V]) Delete(key K)

func (*LruCache[K, V]) Get

func (c *LruCache[K, V]) Get(key K) (value V, err error)

func (*LruCache[K, V]) Set

func (c *LruCache[K, V]) Set(key K, value V)

func (*LruCache[K, V]) Stop

func (c *LruCache[K, V]) Stop()

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithBackgroundCheckCache

func WithBackgroundCheckCache() Option

func WithDeleteExpiredCacheOnGet

func WithDeleteExpiredCacheOnGet() Option

func WithEvictCallback

func WithEvictCallback(fn EvictCallback) Option

func WithExpiration

func WithExpiration(expiration time.Duration) Option

func WithGoTimeNow

func WithGoTimeNow() Option

func WithInterval

func WithInterval(interval time.Duration) Option

func WithMaxSize

func WithMaxSize(maxSize int) Option

func WithUpdateCacheExpirationOnGet

func WithUpdateCacheExpirationOnGet() Option

type OptionFunc

type OptionFunc func(o *options)