cache

Documentation

Index

• type Fetcher
• type Local
  • func NewLocal[K comparable, V any](fetch Fetcher[K, V], ttl time.Duration) *Local[K, V]
  • func (c *Local[K, V]) Clear()
  • func (c *Local[K, V]) Get(key K) V
  • func (c *Local[K, V]) GetOrFetch(ctx context.Context, key K) (V, error)
  • func (c *Local[K, V]) Len() int
  • func (c *Local[K, V]) Set(key K, val V)
  • func (c *Local[K, V]) Start()
  • func (c *Local[K, V]) Stop()

Types

type Fetcher

type Fetcher[K comparable, V any] func(context.Context, K) (V, error)

Fetcher is a function which can fetch an item which doesn't yet exist in the cache.

type Local

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

Local is a generic in-memory cache with builtin in fetching of missing items.

func NewLocal

func NewLocal[K comparable, V any](fetch Fetcher[K, V], ttl time.Duration) *Local[K, V]

NewLocal creates a new in-memory cache.

func (*Local[K, V]) Clear

func (c *Local[K, V]) Clear()

Clear removes all items from the cache.

func (*Local[K, V]) Get

func (c *Local[K, V]) Get(key K) V

Get returns the item with the given key from the cache or the type's zero value.

func (*Local[K, V]) GetOrFetch

func (c *Local[K, V]) GetOrFetch(ctx context.Context, key K) (V, error)

GetOrFetch looks for the item in cache and if not found tries to fetch it.

func (*Local[K, V]) Len

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

Len returns the number of items in the cache.

func (*Local[K, V]) Set

func (c *Local[K, V]) Set(key K, val V)

Set overwrites the value for the given key.

func (*Local[K, V]) Start

func (c *Local[K, V]) Start()

Start starts the routine to eliminate expired items from the cache.

func (*Local[K, V]) Stop

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

Stop stops that routine.