store

Documentation

Index

• Constants
• type BigcacheClientInterface
• type BigcacheStore
  • func NewBigcache(client BigcacheClientInterface, options *Options) *BigcacheStore
  • func (s *BigcacheStore) Get(key interface{}) (interface{}, error)
  • func (s *BigcacheStore) GetType() string
  • func (s *BigcacheStore) Set(key interface{}, value interface{}, options *Options) error
• type MemcacheClientInterface
• type MemcacheStore
  • func NewMemcache(client MemcacheClientInterface, options *Options) *MemcacheStore
  • func (s *MemcacheStore) Get(key interface{}) (interface{}, error)
  • func (s *MemcacheStore) GetType() string
  • func (s *MemcacheStore) Set(key interface{}, value interface{}, options *Options) error
• type MockBigcacheClientInterface
  • func (_m *MockBigcacheClientInterface) Get(key string) ([]byte, error)
  • func (_m *MockBigcacheClientInterface) Set(key string, entry []byte) error
• type MockMemcacheClientInterface
  • func (_m *MockMemcacheClientInterface) Get(key string) (*memcache.Item, error)
  • func (_m *MockMemcacheClientInterface) Set(item *memcache.Item) error
• type MockRedisClientInterface
  • func (_m *MockRedisClientInterface) Get(key string) *redis.StringCmd
  • func (_m *MockRedisClientInterface) Set(key string, value interface{}, expiration time.Duration) *redis.StatusCmd
• type MockRistrettoClientInterface
  • func (_m *MockRistrettoClientInterface) Get(key interface{}) (interface{}, bool)
  • func (_m *MockRistrettoClientInterface) Set(key interface{}, value interface{}, cost int64) bool
• type Options
  • func (o Options) CostValue() int64
  • func (o Options) ExpirationValue() time.Duration
• type RedisClientInterface
• type RedisStore
  • func NewRedis(client RedisClientInterface, options *Options) *RedisStore
  • func (s *RedisStore) Get(key interface{}) (interface{}, error)
  • func (s *RedisStore) GetType() string
  • func (s *RedisStore) Set(key interface{}, value interface{}, options *Options) error
• type RistrettoClientInterface
• type RistrettoStore
  • func NewRistretto(client RistrettoClientInterface, options *Options) *RistrettoStore
  • func (s *RistrettoStore) Get(key interface{}) (interface{}, error)
  • func (s *RistrettoStore) GetType() string
  • func (s *RistrettoStore) Set(key interface{}, value interface{}, options *Options) error
• type StoreInterface

Constants

const (
	BigcacheType = "bigcache"
)

const (
	MemcacheType = "memcache"
)

const (
	RedisType = "redis"
)

const (
	RistrettoType = "ristretto"
)

Types

type BigcacheClientInterface

type BigcacheClientInterface interface {
	Get(key string) ([]byte, error)
	Set(key string, entry []byte) error
}

BigcacheClientInterface represents a allegro/bigcache client

type BigcacheStore

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

BigcacheStore is a store for Redis

func NewBigcache

func NewBigcache(client BigcacheClientInterface, options *Options) *BigcacheStore

NewBigcache creates a new store to Bigcache instance(s)

func (*BigcacheStore) Get

func (s *BigcacheStore) Get(key interface{}) (interface{}, error)

Get returns data stored from a given key

func (*BigcacheStore) GetType

func (s *BigcacheStore) GetType() string

GetType returns the store type

func (*BigcacheStore) Set

func (s *BigcacheStore) Set(key interface{}, value interface{}, options *Options) error

Set defines data in Redis for given key idntifier

type MemcacheClientInterface

type MemcacheClientInterface interface {
	Get(key string) (item *memcache.Item, err error)
	Set(item *memcache.Item) error
}

MemcacheClientInterface represents a bradfitz/gomemcache client

type MemcacheStore

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

MemcacheStore is a store for Redis

func NewMemcache

func NewMemcache(client MemcacheClientInterface, options *Options) *MemcacheStore

NewMemcache creates a new store to Memcache instance(s)

func (*MemcacheStore) Get

func (s *MemcacheStore) Get(key interface{}) (interface{}, error)

Get returns data stored from a given key

func (*MemcacheStore) GetType

func (s *MemcacheStore) GetType() string

GetType returns the store type

func (*MemcacheStore) Set

func (s *MemcacheStore) Set(key interface{}, value interface{}, options *Options) error

Set defines data in Redis for given key idntifier

type MockBigcacheClientInterface

type MockBigcacheClientInterface struct {
	mock.Mock
}

MockBigcacheClientInterface is an autogenerated mock type for the BigcacheClientInterface type

func (*MockBigcacheClientInterface) Get

func (_m *MockBigcacheClientInterface) Get(key string) ([]byte, error)

Get provides a mock function with given fields: key

func (*MockBigcacheClientInterface) Set

func (_m *MockBigcacheClientInterface) Set(key string, entry []byte) error

Set provides a mock function with given fields: key, entry

type MockMemcacheClientInterface

type MockMemcacheClientInterface struct {
	mock.Mock
}

MockMemcacheClientInterface is an autogenerated mock type for the MemcacheClientInterface type

func (*MockMemcacheClientInterface) Get

func (_m *MockMemcacheClientInterface) Get(key string) (*memcache.Item, error)

Get provides a mock function with given fields: key

func (*MockMemcacheClientInterface) Set

func (_m *MockMemcacheClientInterface) Set(item *memcache.Item) error

Set provides a mock function with given fields: item

type MockRedisClientInterface

type MockRedisClientInterface struct {
	mock.Mock
}

MockRedisClientInterface is an autogenerated mock type for the RedisClientInterface type

func (*MockRedisClientInterface) Get

func (_m *MockRedisClientInterface) Get(key string) *redis.StringCmd

Get provides a mock function with given fields: key

func (*MockRedisClientInterface) Set

func (_m *MockRedisClientInterface) Set(key string, value interface{}, expiration time.Duration) *redis.StatusCmd

Set provides a mock function with given fields: key, value, expiration

type MockRistrettoClientInterface

type MockRistrettoClientInterface struct {
	mock.Mock
}

MockRistrettoClientInterface is an autogenerated mock type for the RistrettoClientInterface type

func (*MockRistrettoClientInterface) Get

func (_m *MockRistrettoClientInterface) Get(key interface{}) (interface{}, bool)

Get provides a mock function with given fields: key

func (*MockRistrettoClientInterface) Set

func (_m *MockRistrettoClientInterface) Set(key interface{}, value interface{}, cost int64) bool

Set provides a mock function with given fields: key, value, cost

type Options

type Options struct {
	// Cost corresponds to the memory capacity used by the item when setting a value
	// Actually it seems to be used by Ristretto library only
	Cost int64

	// Expiration allows to specify an expiration time when setting a value
	Expiration time.Duration
}

Options represents the cache store available options

func (Options) CostValue

func (o Options) CostValue() int64

CostValue returns the allocated memory capacity

func (Options) ExpirationValue

func (o Options) ExpirationValue() time.Duration

ExpirationValue returns the expiration option value

type RedisClientInterface

type RedisClientInterface interface {
	Get(key string) *redis.StringCmd
	Set(key string, value interface{}, expiration time.Duration) *redis.StatusCmd
}

RedisClientInterface represents a go-redis/redis client

type RedisStore

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

RedisStore is a store for Redis

func NewRedis

func NewRedis(client RedisClientInterface, options *Options) *RedisStore

NewRedis creates a new store to Redis instance(s)

func (*RedisStore) Get

func (s *RedisStore) Get(key interface{}) (interface{}, error)

Get returns data stored from a given key

func (*RedisStore) GetType

func (s *RedisStore) GetType() string

GetType returns the store type

func (*RedisStore) Set

func (s *RedisStore) Set(key interface{}, value interface{}, options *Options) error

Set defines data in Redis for given key idntifier

type RistrettoClientInterface

type RistrettoClientInterface interface {
	Get(key interface{}) (interface{}, bool)
	Set(key, value interface{}, cost int64) bool
}

RistrettoClientInterface represents a dgraph-io/ristretto client

type RistrettoStore

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

RistrettoStore is a store for Ristretto (memory) library

func NewRistretto

func NewRistretto(client RistrettoClientInterface, options *Options) *RistrettoStore

NewRistretto creates a new store to Ristretto (memory) library instance

func (*RistrettoStore) Get

func (s *RistrettoStore) Get(key interface{}) (interface{}, error)

Get returns data stored from a given key

func (*RistrettoStore) GetType

func (s *RistrettoStore) GetType() string

GetType returns the store type

func (*RistrettoStore) Set

func (s *RistrettoStore) Set(key interface{}, value interface{}, options *Options) error

Set defines data in Ristretto memoey cache for given key idntifier

type StoreInterface

type StoreInterface interface {
	Get(key interface{}) (interface{}, error)
	Set(key interface{}, value interface{}, options *Options) error
	GetType() string
}

StoreInterface is the interface for all available stores