cache

Documentation

Index

• func RegisterFactory(driver string, factory Factory)
• type Cache
  • func NewCache(prefix string, store Store) *Cache
  • func (cache *Cache) Get(ctx context.Context, key string, value any) error
  • func (cache *Cache) Set(ctx context.Context, key string, value any, ttl time.Duration) error
• type Factory
  • func NewRedisFactory(client *redis.Client) Factory
• type MemoryStore
  • func NewMemoryStore() *MemoryStore
  • func (s *MemoryStore) Get(ctx context.Context, key string, value any) error
  • func (s *MemoryStore) Has(ctx context.Context, key string) bool
  • func (s *MemoryStore) Set(ctx context.Context, key string, value any, ttl time.Duration) error
• type RedisStore
  • func NewRedisStore(options *cache.Options) *RedisStore
  • func (s *RedisStore) Get(ctx context.Context, key string, value interface{}) error
  • func (s *RedisStore) Has(ctx context.Context, key string) bool
  • func (s *RedisStore) Set(ctx context.Context, key string, value any, ttl time.Duration) error
• type Store
  • func Make(driver string, opts typed.Typed) (Store, error)

Functions

func RegisterFactory

func RegisterFactory(driver string, factory Factory)

Types

type Cache

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

func NewCache

func NewCache(prefix string, store Store) *Cache

Create a new cache

func (*Cache) Get

func (cache *Cache) Get(ctx context.Context, key string, value any) error

func (*Cache) Set

func (cache *Cache) Set(ctx context.Context, key string, value any, ttl time.Duration) error

type Factory

type Factory func(opts typed.Typed) (Store, error)

func NewRedisFactory

func NewRedisFactory(client *redis.Client) Factory

type MemoryStore

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

func NewMemoryStore

func NewMemoryStore() *MemoryStore

func (*MemoryStore) Get

func (s *MemoryStore) Get(ctx context.Context, key string, value any) error

func (*MemoryStore) Has

func (s *MemoryStore) Has(ctx context.Context, key string) bool

func (*MemoryStore) Set

func (s *MemoryStore) Set(ctx context.Context, key string, value any, ttl time.Duration) error

type RedisStore

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

func NewRedisStore

func NewRedisStore(options *cache.Options) *RedisStore

func (*RedisStore) Get

func (s *RedisStore) Get(ctx context.Context, key string, value interface{}) error

func (*RedisStore) Has

func (s *RedisStore) Has(ctx context.Context, key string) bool

func (*RedisStore) Set

func (s *RedisStore) Set(ctx context.Context, key string, value any, ttl time.Duration) error

type Store

type Store interface {
	// Set an item in the store.
	Set(ctx context.Context, key string, value any, TTL time.Duration) error

	// Get an item from the store.
	// returns an error if key is not found or there is other problems.
	Get(ctx context.Context, key string, value any) error

	// Check if a key exist in the store.
	Has(ctx context.Context, key string) bool
}

Interface to a cache storage.

func Make

func Make(driver string, opts typed.Typed) (Store, error)