cache

Documentation

Index

• func Bypass(ctx context.Context) context.Context
• func IsBypassed(ctx context.Context) bool
• 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]) WithExtendOnHit() *App[K, V]
  • func (a *App[K, V]) WithMaxConcurrency(concurrency int) *App[K, V]
  • func (a *App[K, V]) WithMissMany(cb fetchMany[K, V]) *App[K, V]
  • func (a *App[K, V]) WithRead(client RedisClient) *App[K, V]
  • func (a *App[K, V]) WithSerializer(serializer Serializer[V]) *App[K, V]
  • func (a *App[K, V]) WithTTL(ttl time.Duration) *App[K, V]
• type IndexedItems
  • func (ii IndexedItems[K]) Items() []K
• type JSONSerializer
  • func (JSONSerializer[V]) Decode(payload []byte) (V, error)
  • func (JSONSerializer[V]) Encode(payload V) ([]byte, error)
• type RedisClient
• type Serializer
• type StringSerializer
  • func (StringSerializer) Decode(payload []byte) (string, error)
  • func (StringSerializer) Encode(payload string) ([]byte, error)

Functions

func Bypass

func Bypass(ctx context.Context) context.Context

func IsBypassed

func IsBypassed(ctx context.Context) bool

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], tracerProvider trace.TracerProvider) *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]) WithExtendOnHit

func (a *App[K, V]) WithExtendOnHit() *App[K, V]

func (*App[K, V]) WithMaxConcurrency

func (a *App[K, V]) WithMaxConcurrency(concurrency int) *App[K, V]

func (*App[K, V]) WithMissMany

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

func (*App[K, V]) WithRead

func (a *App[K, V]) WithRead(client RedisClient) *App[K, V]

func (*App[K, V]) WithSerializer

func (a *App[K, V]) WithSerializer(serializer Serializer[V]) *App[K, V]

func (*App[K, V]) WithTTL

func (a *App[K, V]) WithTTL(ttl time.Duration) *App[K, V]

type IndexedItems

type IndexedItems[K comparable] map[K]int

func (IndexedItems[K]) Items

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

type JSONSerializer

type JSONSerializer[V any] struct{}

func (JSONSerializer[V]) Decode

func (JSONSerializer[V]) Decode(payload []byte) (V, error)

func (JSONSerializer[V]) Encode

func (JSONSerializer[V]) Encode(payload V) ([]byte, error)

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
}

type Serializer

type Serializer[V any] interface {
	Encode(V) ([]byte, error)
	Decode([]byte) (V, error)
}

type StringSerializer

type StringSerializer struct{}

func (StringSerializer) Decode

func (StringSerializer) Decode(payload []byte) (string, error)

func (StringSerializer) Encode

func (StringSerializer) Encode(payload string) ([]byte, error)