cache

Documentation

Index

• Variables
• func WithContext(ctx context.Context, cch Cache) context.Context
• type Cache
  • func Ctx(ctx context.Context) Cache
• type Evictor

Variables

var Module = fx.Options(
	fx.Provide(newCache),
	fx.Invoke(registerCacheEviction),
)

nolint

Functions

func WithContext

func WithContext(ctx context.Context, cch Cache) context.Context

WithContext returns a copy of ctx with cache associated. If a Cache instance is already in the context, the ctx is not updated.

For instance, to make use of the cache in the context, use this notation:

ctx := r.Context()
cch := cache.Ctx(ctx)
val := cch.Get("some key")
use val

Types

type Cache

type Cache interface {
	Get(key string) any
	Set(key string, value any, ttl time.Duration)
	Delete(key string)
}

func Ctx

func Ctx(ctx context.Context) Cache

Ctx returns the Cache associated with the ctx. If no cache is associated, an instance is returned, which does nothing.

type Evictor

type Evictor interface {
	Start()
	Stop()
}