cache

Documentation

Index

• type Cache
• type Redis
  • func NewRedis(conn, pwd string, ttl time.Duration) (Redis, error)
  • func (c *Redis) Get(ctx context.Context, key string, typ interface{}) error
  • func (c *Redis) Set(ctx context.Context, key string, value interface{}) error

Types

type Cache

type Cache interface {
	// Get tries to retrieve an item from cache using the specified key. If the item does not exist, nil is returned.
	// Value is returned by means of a reference argument `typ`
	Get(ctx context.Context, key string, typ interface{}) error
	// Set will add an item to the cache using the key. If an item exists, it is overwritten.
	Set(ctx context.Context, key string, value interface{}) error
}

Cache defines functionality to cache and retrieve items from an underlying store

type Redis

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

Redis implements storage of objects in Redis, objects are serialised using JSON

func NewRedis

func NewRedis(conn, pwd string, ttl time.Duration) (Redis, error)

NewRedis returns a new instance of redis

func (*Redis) Get

func (c *Redis) Get(ctx context.Context, key string, typ interface{}) error

Get tries to retrieve an item from cache using the specified key. If the item does not exist, nil is returned.

func (*Redis) Set

func (c *Redis) Set(ctx context.Context, key string, value interface{}) error

Set will add an item to the cache using the key. If an item exists, it is overwritten.