cache

Documentation

Index

• Variables
• func EncodeKey(keys ...string) string
• func GetOrSet[T any](cache Cache, ctx context.Context, key string, ttl time.Duration, ...) (*T, error)
• func Key(k string) (string, error)
• func Marshal(v any) ([]byte, error)
• func Unmarshal(data []byte, v any) error
• type Cache
  • func New(conf *config.Config) (Cache, error)
  • func NewNoop() Cache
  • func NewRedis(conf *config.Config) (Cache, error)

Variables

var (
	ErrAlreadyConnected = errors.New("CACHE.ALREADY_CONNECTED.ERROR")
	ErrNotConnected     = errors.New("CACHE.NOT_CONNECTED.ERROR")
	ErrEntryNotFound    = errors.New("CACHE.ENTRY.NOT_FOUND.ERROR")
	ErrKeyEmpty         = errors.New("CACHE.KEY.EMPTY.ERROR")
)

Functions

func EncodeKey

func EncodeKey(keys ...string) string

func GetOrSet

func GetOrSet[T any](cache Cache, ctx context.Context, key string, ttl time.Duration, fn func() (*T, error)) (*T, error)

GetOrSet is a helper function that allow you get existing entry from the cache or set it if it does not exist yet the function must return a pointer of the expected type and an error

func Key

func Key(k string) (string, error)

func Marshal

func Marshal(v any) ([]byte, error)

func Unmarshal

func Unmarshal(data []byte, v any) error

Types

type Cache

type Cache interface {
	patterns.Connectable
	Get(ctx context.Context, key string, entry any) error
	Set(ctx context.Context, key string, entry any, ttl time.Duration) error
	Exist(ctx context.Context, key string) bool
	Del(ctx context.Context, key string) error
	Expire(ctx context.Context, key string, at time.Time) error
}

func New

func New(conf *config.Config) (Cache, error)

func NewNoop

func NewNoop() Cache

func NewRedis

func NewRedis(conf *config.Config) (Cache, error)