cachefx

README

cachefx

example：

import (
    "github.com/damonchen/cachefx"
    "go.uber.org/fx"
)

// using memory cache
fx.Module("cache",
    fx.Provide(
        fx.Annotate(
            cachefx.NewMemoryCache,
            fx.As(new(Cache)),
            fx.ResultTags(`name:"cache"`)),
    ))

Documentation

Index

• Variables
• type Cache
• type MemoryCache
  • func NewMemoryCache() *MemoryCache
  • func (c *MemoryCache) Delete(ctx context.Context, key string) error
  • func (c *MemoryCache) Get(ctx context.Context, key string) ([]byte, error)
  • func (c *MemoryCache) Set(ctx context.Context, key string, value []byte, expiration time.Duration) error
• type RedisCache
  • func NewRedisCache(client *redis.Client) *RedisCache
  • func (r *RedisCache) Delete(ctx context.Context, key string) error
  • func (r *RedisCache) Get(ctx context.Context, key string) ([]byte, error)
  • func (r *RedisCache) Set(ctx context.Context, key string, value []byte, expiration time.Duration) error

Variables

var (
	// ErrNotFound not found
	ErrNotFound = errors.New("key not exists")
)

Types

type Cache

type Cache interface {
	// Get get value from cache with value
	Get(ctx context.Context, key string) ([]byte, error)
	// Set set value to the cache with key of ttl
	Set(ctx context.Context, key string, value []byte, expiration time.Duration) error
	// Delete clear item in the cache
	Delete(ctx context.Context, key string) error
}

type MemoryCache

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

MemoryCache memory cache

func NewMemoryCache

func NewMemoryCache() *MemoryCache

NewMemoryCache new memory cache

func (*MemoryCache) Delete

func (c *MemoryCache) Delete(ctx context.Context, key string) error

func (*MemoryCache) Get

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

func (*MemoryCache) Set

func (c *MemoryCache) Set(ctx context.Context, key string, value []byte,
	expiration time.Duration) error

type RedisCache

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

RedisCache redis cache

func NewRedisCache

func NewRedisCache(client *redis.Client) *RedisCache

NewRedisCache new redis cache

func (*RedisCache) Delete

func (r *RedisCache) Delete(ctx context.Context, key string) error

func (*RedisCache) Get

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

func (*RedisCache) Set

func (r *RedisCache) Set(ctx context.Context, key string, value []byte,
	expiration time.Duration) error