cache

Documentation

Index

• Variables
• func Register(typ string, factory Factory)
• func WithContext(ctx context.Context, cch Cache) context.Context
• type Cache
  • func Create(typ string, config map[string]any, cw watcher.Watcher) (Cache, error)
  • func Ctx(ctx context.Context) Cache
• type Factory
• type FactoryFunc
  • func (f FactoryFunc) Create(conf map[string]any, cw watcher.Watcher) (Cache, error)

Variables

var (
	ErrUnsupportedCacheType = errors.New("cache type unsupported")
)

Functions

func Register

func Register(typ string, factory Factory)

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.

Types

type Cache

type Cache interface {
	Start(ctx context.Context) error
	Stop(ctx context.Context) error

	Get(ctx context.Context, key string) ([]byte, error)
	Set(ctx context.Context, key string, value []byte, ttl time.Duration) error
}

func Create

func Create(typ string, config map[string]any, cw watcher.Watcher) (Cache, error)

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 Factory

type Factory interface {
	Create(conf map[string]any, cw watcher.Watcher) (Cache, error)
}

type FactoryFunc

type FactoryFunc func(conf map[string]any, cw watcher.Watcher) (Cache, error)

func (FactoryFunc) Create

func (f FactoryFunc) Create(conf map[string]any, cw watcher.Watcher) (Cache, error)