cache

Documentation

Index

• Variables
• type Cache
  • func New(cfg config.CacheConfig, options ...Option) (Cache, error)
• type Option
  • func WithCacheKeys(keys ...string) Option

Variables

var (
	ErrInvalidCacheType = errors.New("invalid cache type")
	ErrCacheProcessing  = errors.New("cache processing error")
)

Types

type Cache

type Cache interface {
	// Load returns cached string by using the key, and whether or not cache is expired. If a cache is empty,
	// returned a string is nil and expired is true.
	Load(ctx context.Context, key string, decrypt bool) (*string, bool, error)

	// Save saves value to cache. If encrypt is true, value is encrypted before saving.
	Save(ctx context.Context, key string, value *string, encrypt bool) error
}

func New

func New(cfg config.CacheConfig, options ...Option) (Cache, error)

type Option

type Option func(*opts)

Option is configurable Cache behavior.

func WithCacheKeys

func WithCacheKeys(keys ...string) Option

WithCacheKeys sets the keys to be used in the cache.