cache

Documentation

Index

• Variables
• type CacheType
• type Cacher
  • func New(cacheType CacheType, address string, password string, ...) (Cacher, error)

Variables

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

ErrInvalidCacheType is error for invalid cache type.

Types

type CacheType

type CacheType int8

CacheType is type for cache.

const (
	NoCache CacheType = iota
	InMemory
	Redis
	Memcache
)

Available types for cache.

type Cacher

type Cacher interface {
	// Get data from cache. The returned value will be
	// assigned to param `data`. Param `data` should
	// be a pointer just like when using json.Unmarshal.
	Get(ctx context.Context, key string, data interface{}) error
	// Save data to cache. Set and Get should be using
	// the same encoding method. For example, json.Marshal
	// for Set and json.Unmarshal for Get.
	Set(ctx context.Context, key string, data interface{}, ttl ...time.Duration) error
	// Delete data from cache.
	Delete(ctx context.Context, key string) error
	// Close cache connection.
	Close() error
}

Cacher is caching interface.

See usage example in example folder.

func New

func New(cacheType CacheType, address string, password string, expiredTime time.Duration) (Cacher, error)

New to create new cache client depends on the type.