The highest tagged major version is
README
¶
Cache
This package provides an interface to interact with different cache stores, like BigCache and Redis. It allows you to perform common cache operations like Get/Set/Delete and Clear the entire cache.
Cache is optional, you can pass nil when building the equinox client and it will disable caching. The cache is enabled by default and uses BigCache.
The idea is to keep this package small and simple, providing only one internal cache and an external database, preferably Redis.
You can interact with the cache from the equinox client:
client, err := equinox.NewClient("RIOT_API_KEY")
body, err := client.Cache.Get("https://euw1.api.riotgames.com/...") // []byte, error
Stores
Documentation
¶
Overview ¶
Cache package to provide an interface to interact with cache stores.
Index ¶
- Variables
- type BigCacheClient
- type BigCacheStore
- type Cache
- func (c *Cache) Clear(ctx context.Context) error
- func (c *Cache) Delete(ctx context.Context, key string) error
- func (c *Cache) Get(ctx context.Context, key string) ([]byte, error)
- func (c Cache) MarshalZerologObject(encoder *zerolog.Event)
- func (c *Cache) Set(ctx context.Context, key string, item []byte) error
- type RedisClient
- type RedisStore
- type Store
- type StoreType
Constants ¶
This section is empty.
Variables ¶
var ( ErrCacheIsDisabled = errors.New("cache is disabled") ErrRedisOptionsNil = errors.New("redis options is nil") )
Functions ¶
This section is empty.
Types ¶
type BigCacheClient ¶
type BigCacheStore ¶
type BigCacheStore struct {
// contains filtered or unexported fields
}
func (*BigCacheStore) Delete ¶
func (s *BigCacheStore) Delete(_ctx context.Context, key string) error
type Cache ¶
type Cache struct {
StoreType StoreType
TTL time.Duration
Enabled bool
// contains filtered or unexported fields
}
func NewBigCache ¶
Creates a new Cache using BigCache.
Requires a BigCache config that can be created with bigcache.DefaultConfig(n*time.Minute).
func (*Cache) Get ¶
Returns an item from the cache. If no item is found, returns nil for the item and error.
func (Cache) MarshalZerologObject ¶ added in v1.0.0
type RedisClient ¶
type RedisStore ¶
type RedisStore struct {
// contains filtered or unexported fields
}
Source Files