cache

Documentation

Index

• func Bypass(ctx context.Context) context.Context
• func IsBypassed(ctx context.Context) bool
• type Cache
  • func New[K comparable, V any](client RedisClient, toKey keyer[K], onMiss fetch[K, V], ...) *Cache[K, V]
  • func (c *Cache[K, V]) EvictOnSuccess(ctx context.Context, id K, err error) error
  • func (c *Cache[K, V]) Get(ctx context.Context, id K) (V, error)
  • func (c *Cache[K, V]) List(ctx context.Context, ids ...K) (outputs []V, err error)
  • func (c *Cache[K, V]) Store(ctx context.Context, id K, value V) error
  • func (c *Cache[K, V]) WithClientSideCaching(ctx context.Context, channel string, size int) *Cache[K, V]
  • func (c *Cache[K, V]) WithExtendOnHit(ctx context.Context, interval time.Duration, maxSize int) *Cache[K, V]
  • func (c *Cache[K, V]) WithMaxConcurrency(concurrency int) *Cache[K, V]
  • func (c *Cache[K, V]) WithMissMany(cb fetchMany[K, V]) *Cache[K, V]
  • func (c *Cache[K, V]) WithRead(client RedisClient) *Cache[K, V]
  • func (c *Cache[K, V]) WithSerializer(serializer Serializer[V]) *Cache[K, V]
  • func (c *Cache[K, V]) WithTTL(ttl time.Duration) *Cache[K, V]
• type IndexedID
• type IndexedIDs
  • func (ii IndexedIDs[K]) IDs() []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)
• type TTLExtender
  • func NewExtender(ttl, interval time.Duration, maxSize int, redis RedisClient) *TTLExtender
  • func (te *TTLExtender) Extend(ctx context.Context, keys ...string) error
  • func (te *TTLExtender) Start(ctx context.Context)

Functions

func Bypass

func Bypass(ctx context.Context) context.Context

func IsBypassed

func IsBypassed(ctx context.Context) bool

Types

type Cache

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

func New

func New[K comparable, V any](client RedisClient, toKey keyer[K], onMiss fetch[K, V], tracerProvider trace.TracerProvider) *Cache[K, V]

func (*Cache[K, V]) EvictOnSuccess

func (c *Cache[K, V]) EvictOnSuccess(ctx context.Context, id K, err error) error

func (*Cache[K, V]) Get

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

func (*Cache[K, V]) List

func (c *Cache[K, V]) List(ctx context.Context, ids ...K) (outputs []V, err error)

func (*Cache[K, V]) Store

func (c *Cache[K, V]) Store(ctx context.Context, id K, value V) error

func (*Cache[K, V]) WithClientSideCaching

func (c *Cache[K, V]) WithClientSideCaching(ctx context.Context, channel string, size int) *Cache[K, V]

func (*Cache[K, V]) WithExtendOnHit

func (c *Cache[K, V]) WithExtendOnHit(ctx context.Context, interval time.Duration, maxSize int) *Cache[K, V]

func (*Cache[K, V]) WithMaxConcurrency

func (c *Cache[K, V]) WithMaxConcurrency(concurrency int) *Cache[K, V]

func (*Cache[K, V]) WithMissMany

func (c *Cache[K, V]) WithMissMany(cb fetchMany[K, V]) *Cache[K, V]

func (*Cache[K, V]) WithRead

func (c *Cache[K, V]) WithRead(client RedisClient) *Cache[K, V]

func (*Cache[K, V]) WithSerializer

func (c *Cache[K, V]) WithSerializer(serializer Serializer[V]) *Cache[K, V]

func (*Cache[K, V]) WithTTL

func (c *Cache[K, V]) WithTTL(ttl time.Duration) *Cache[K, V]

type IndexedID

type IndexedID[K comparable] struct {
	// contains filtered or unexported fields
}

type IndexedIDs

type IndexedIDs[K comparable] []IndexedID[K]

func (IndexedIDs[K]) IDs

func (ii IndexedIDs[K]) IDs() []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
	StoreMany(ctx context.Context, values map[string]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

	PublishJSON(ctx context.Context, channel string, value any) error
	Subscribe(ctx context.Context, channel string) (<-chan *redis.Message, func(context.Context))
}

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)

type TTLExtender

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

func NewExtender

func NewExtender(ttl, interval time.Duration, maxSize int, redis RedisClient) *TTLExtender

func (*TTLExtender) Extend

func (te *TTLExtender) Extend(ctx context.Context, keys ...string) error

func (*TTLExtender) Start

func (te *TTLExtender) Start(ctx context.Context)