cache

Documentation

Index

• Variables
• func AddCacheFlagsToCmd(cmd *cobra.Command) func() (*Cache, error)
• type Cache
  • func NewCache(client CacheClient) *Cache
  • func (c *Cache) GetItem(key string, item interface{}) error
  • func (c *Cache) SetItem(key string, item interface{}, expiration time.Duration, delete bool) error
• type CacheClient
  • func NewRedisCache(client *redis.Client, expiration time.Duration) CacheClient
• type InMemoryCache
  • func NewInMemoryCache(expiration time.Duration) *InMemoryCache
  • func (i *InMemoryCache) Delete(key string) error
  • func (i *InMemoryCache) Flush()
  • func (i *InMemoryCache) Get(key string, obj interface{}) error
  • func (i *InMemoryCache) Set(item *Item) error
• type Item

Variables

var ErrCacheMiss = errors.New("cache: key is missing")

Functions

func AddCacheFlagsToCmd

func AddCacheFlagsToCmd(cmd *cobra.Command) func() (*Cache, error)

AddCacheFlagsToCmd adds flags which control caching to the specified command

Types

type Cache

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

Cache provides strongly types methods to store and retrieve values from shared cache

func NewCache

func NewCache(client CacheClient) *Cache

func (*Cache) GetItem

func (c *Cache) GetItem(key string, item interface{}) error

func (*Cache) SetItem

func (c *Cache) SetItem(key string, item interface{}, expiration time.Duration, delete bool) error

type CacheClient

type CacheClient interface {
	Set(item *Item) error
	Get(key string, obj interface{}) error
	Delete(key string) error
}

func NewRedisCache

func NewRedisCache(client *redis.Client, expiration time.Duration) CacheClient

type InMemoryCache

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

func NewInMemoryCache

func NewInMemoryCache(expiration time.Duration) *InMemoryCache

func (*InMemoryCache) Delete

func (i *InMemoryCache) Delete(key string) error

func (*InMemoryCache) Flush

func (i *InMemoryCache) Flush()

func (*InMemoryCache) Get

func (i *InMemoryCache) Get(key string, obj interface{}) error

func (*InMemoryCache) Set

func (i *InMemoryCache) Set(item *Item) error

type Item

type Item struct {
	Key    string
	Object interface{}
	// Expiration is the cache expiration time.
	Expiration time.Duration
}