Documentation
¶
Overview ¶
Package cache implement a simple cache redis client. It define a type Cache that represent the cache client and It define the methods Get to get a valur from a cache key.
Index ¶
Constants ¶
This section is empty.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type Cache ¶
type Cache interface {
CacheReadable
CacheWriteable
}
Cache is the interface for cache client.
type CacheClient ¶
type CacheClient struct {
Client *redis.Client
Enabled bool
Prefix string
// contains filtered or unexported fields
}
CacheClient redis cache client.
func NewCacheClient ¶
func NewCacheClient(redisClient *redis.Client, enabled bool, prefix string, log *zap.Logger) (*CacheClient, error)
NewCacheClient init a new cache client.
func (*CacheClient) Get ¶
Get get a cache value or error from a key. If the cache is not enabled, the error value If the cache not contain a value from a key, the error value errors.ErrNotFound is returned. If exist some internal error in the cache, the error value errros.ErrInternalError is returned.
type CacheReadable ¶
CacheReadable is the interface for read cache.
type CacheWriteable ¶
type CacheWriteable interface {
Set(ctx context.Context, key string, value interface{}, expirations time.Duration) error
}
CacheWriteable is the interface for write cache.
type DummyCacheClient ¶
type DummyCacheClient struct {
}
DummyCacheClient dummy cache client.
func NewDummyCacheClient ¶
func NewDummyCacheClient() *DummyCacheClient
NewDummyCacheClient create a new instance of DummyCacheClient
Source Files
Directories