cache

Documentation

Index

• Constants
• Variables
• type Cache
• type Config
• type LocalCache
  • func NewLocalCache(cfg Config) *LocalCache
  • func (lc *LocalCache) Delete(ctx context.Context, key string) error
  • func (lc *LocalCache) Get(ctx context.Context, key string) ([]byte, error)
  • func (lc *LocalCache) Set(ctx context.Context, key string, data []byte, exp time.Duration) error

Constants

const (
	NoExpiration      = gocache.NoExpiration
	DefaultExpiration = gocache.DefaultExpiration
)

Variables

var (
	ErrNotFound = errors.New("not found")
	ErrRead     = errors.New("could not read value at cache key")
)

Types

type Cache

type Cache interface {
	// Get gets the cache value as an byte array
	Get(ctx context.Context, key string) ([]byte, error)

	// Set saves the value as an byte array. if `expire` is set to zero it will use the cache default expiration time.
	Set(ctx context.Context, key string, value []byte, expire time.Duration) error

	// Delete object from cache
	Delete(ctx context.Context, key string) error
}

Cache allows the caller to set, get and delete items in the cache.

type Config

type Config struct {
	Expiry          time.Duration
	CleanupInterval time.Duration
}

type LocalCache

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

func NewLocalCache

func NewLocalCache(cfg Config) *LocalCache

func (*LocalCache) Delete

func (lc *LocalCache) Delete(ctx context.Context, key string) error

func (*LocalCache) Get

func (lc *LocalCache) Get(ctx context.Context, key string) ([]byte, error)

func (*LocalCache) Set

func (lc *LocalCache) Set(ctx context.Context, key string, data []byte, exp time.Duration) error