cache

Documentation

Index

• func Bypass(ctx context.Context) context.Context
• func EvictOnSucces(ctx context.Context, client RedisClient, key string, err error) error
• func IsBypassed(ctx context.Context) bool
• func Load[V any](ctx context.Context, client RedisClient, key string, ...) (V, error)
• type App
  • func New[K comparable, V any](client RedisClient, toKey func(K) string, onMiss fetch[K, V], ...) *App[K, V]
  • func (a *App[K, V]) EvictOnSuccess(ctx context.Context, item K, err error) error
  • func (a *App[K, V]) Get(ctx context.Context, id K) (V, error)
  • func (a App[K, V]) List(ctx context.Context, onMissError func(K, error) bool, items ...K) (outputs []V, err error)
  • func (a App[K, V]) Store(ctx context.Context, id K, value V) error
  • func (a *App[K, V]) WithMissMany(cb fetchMany[K, V])
• type IndexedItems
  • func (ii IndexedItems[K]) Items() []K
• type RedisClient

Functions

func Bypass

func Bypass(ctx context.Context) context.Context

func EvictOnSucces

func EvictOnSucces(ctx context.Context, client RedisClient, key string, err error) error

func IsBypassed

func IsBypassed(ctx context.Context) bool

func Load

func Load[V any](ctx context.Context, client RedisClient, key string, onMiss func(context.Context) (V, error), ttl time.Duration) (V, error)

Types

type App

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

func New

func New[K comparable, V any](client RedisClient, toKey func(K) string, onMiss fetch[K, V], ttl time.Duration, concurrency uint64, tracer trace.Tracer) *App[K, V]

func (*App[K, V]) EvictOnSuccess

func (a *App[K, V]) EvictOnSuccess(ctx context.Context, item K, err error) error

func (*App[K, V]) Get

func (a *App[K, V]) Get(ctx context.Context, id K) (V, error)

func (App[K, V]) List

func (a App[K, V]) List(ctx context.Context, onMissError func(K, error) bool, items ...K) (outputs []V, err error)

If onMissError returns false, List stops by returning an error

func (App[K, V]) Store

func (a App[K, V]) Store(ctx context.Context, id K, value V) error

func (*App[K, V]) WithMissMany

func (a *App[K, V]) WithMissMany(cb fetchMany[K, V])

type IndexedItems

type IndexedItems[K comparable] map[K]int

func (IndexedItems[K]) Items

func (ii IndexedItems[K]) Items() []K

type RedisClient

type RedisClient interface {
	Enabled() bool
	Load(ctx context.Context, key string) ([]byte, error)
	LoadMany(ctx context.Context, keys ...string) ([]string, error)
	Store(ctx context.Context, key string, value any, ttl time.Duration) error
	Delete(ctx context.Context, keys ...string) error
	Expire(ctx context.Context, ttl time.Duration, keys ...string) error
	Pipeline() redis.Pipeliner
}