cache

Documentation

Index

• Variables
• func Get[T any](ctx context.Context, key string) (*T, error)
• func New(params Params) (config.Cache, error)
• func Persist[T any](ctx context.Context, key string, value *T, ttl time.Duration) error
• func Register(ca config.Cache)
• func Remove(ctx context.Context, key string) error
• type Cache
  • func (c *Cache) Close(_ context.Context) error
  • func (c *Cache) Get(_ context.Context, key string, value any) error
  • func (c *Cache) Persist(_ context.Context, key string, value any, ttl time.Duration) error
  • func (c *Cache) Remove(_ context.Context, key string) error
• type Params

Variables

var Module = fx.Options(
	fx.Provide(cachego.New),
	fx.Provide(New),
	fx.Invoke(Register),
)

Module for fx.

Functions

func Get

func Get[T any](ctx context.Context, key string) (*T, error)

Get a value from key.

func New

func New(params Params) (config.Cache, error)

New from config.

func Persist

func Persist[T any](ctx context.Context, key string, value *T, ttl time.Duration) error

Persist a value to the key with a TTL.

func Register

func Register(ca config.Cache)

Register a cache.

func Remove

func Remove(ctx context.Context, key string) error

Remove a key.

Types

type Cache

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

Cache allows marshaling and compressing items to the cache.

func (*Cache) Close

func (c *Cache) Close(_ context.Context) error

Close the cache.

func (*Cache) Get

func (c *Cache) Get(_ context.Context, key string, value any) error

Get a cached value.

func (*Cache) Persist

func (c *Cache) Persist(_ context.Context, key string, value any, ttl time.Duration) error

Persist a value with key and TTL.

func (*Cache) Remove

func (c *Cache) Remove(_ context.Context, key string) error

Remove a cached key.

type Params

type Params struct {
	fx.In

	Lifecycle  fx.Lifecycle
	Config     *config.Config
	Encoder    *encoding.Map
	Pool       *sync.BufferPool
	Compressor *compress.Map
	Cache      cachego.Cache
	Tracer     trace.Tracer
	Logger     *zap.Logger
	Meter      metric.Meter
}

Params for cache.