lru

Documentation

Index

• type Cache
  • func New(op string, opts ...Option) *Cache
  • func (c *Cache) FindOrFetch(cacheNamespace, key string, fetchFn func() (interface{}, error)) (interface{}, error)
• type Option
  • func WithCachedEntriesMetric(m *prometheus.GaugeVec) Option
  • func WithCachedRequestsMetric(m *prometheus.CounterVec) Option
  • func WithExpirationInterval(t time.Duration) Option
  • func WithMaxSize(i int64) Option

Types

type Cache

type Cache struct {
	// contains filtered or unexported fields
}

Cache wraps a ccache and allows setting custom metrics for hits/misses. duration and maxSize are initialized to their default values but should be configured using WithExpirationInterval and WithMaxSize options.

func New

func New(op string, opts ...Option) *Cache

New creates an LRU cache

func (*Cache) FindOrFetch

func (c *Cache) FindOrFetch(cacheNamespace, key string, fetchFn func() (interface{}, error)) (interface{}, error)

FindOrFetch will try to get the item from the cache if exists and is not expired. If it can't find it, it will call fetchFn to retrieve the item and cache it.

type Option

type Option func(*Cache)

Option function to configure a Cache

func WithCachedEntriesMetric

func WithCachedEntriesMetric(m *prometheus.GaugeVec) Option

func WithCachedRequestsMetric

func WithCachedRequestsMetric(m *prometheus.CounterVec) Option

func WithExpirationInterval

func WithExpirationInterval(t time.Duration) Option

func WithMaxSize

func WithMaxSize(i int64) Option