cache

Documentation

Index

• type Cache
• type Memory
  • func NewMemory() *Memory
  • func (c *Memory) Get(_ context.Context, key string, val any) error
  • func (c *Memory) Has(ctx context.Context, key string) (bool, error)
  • func (c *Memory) Keys(ctx context.Context, pattern string) ([]string, error)
  • func (c *Memory) Set(ctx context.Context, key string, val any, ttl time.Duration) error
• type Redis
  • func NewRedis(dbPrefix string) (*Redis, error)
  • func NewRedisInsecure(host, port string, db int, dbPrefix string) (*Redis, error)
  • func NewRedisSecure(host, port, user, password string, db int, dbPrefix string) (*Redis, error)
  • func (c *Redis) Get(ctx context.Context, key string, val any) error
  • func (c *Redis) Has(ctx context.Context, key string) (bool, error)
  • func (c *Redis) Keys(ctx context.Context, pattern string) ([]string, error)
  • func (c *Redis) Set(ctx context.Context, key string, val any, ttl time.Duration) error

Types

type Cache

type Cache interface {
	Get(context.Context, string, any) error
	Set(context.Context, string, any, time.Duration) error
	Has(context.Context, string) (bool, error)
	Keys(context.Context, string) ([]string, error)
}

type Memory

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

func NewMemory

func NewMemory() *Memory

func (*Memory) Get

func (c *Memory) Get(_ context.Context, key string, val any) error

func (*Memory) Has

func (c *Memory) Has(ctx context.Context, key string) (bool, error)

func (*Memory) Keys

func (c *Memory) Keys(ctx context.Context, pattern string) ([]string, error)

Keys will return the set of keys in the cache matching the given "*" based pattern. WARNING: This implementation only supports a single wildcard.

func (*Memory) Set

func (c *Memory) Set(ctx context.Context, key string, val any, ttl time.Duration) error

Set will create a cache file for the given key. TODO: Support TTL based expirations

type Redis

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

func NewRedis

func NewRedis(dbPrefix string) (*Redis, error)

NewRedis instantiates a new Cache client backed by Redis. This will connect to Redis based on the presence of environment variables.

If the `REDIS_USER` or `REDIS_PASSWORD` (or `REDIS_PASS`) environment variables are set, the connection will be upgraded to secure.

By default DB 0 is used, but can be configured with the `REDIS_DB` environment variable.

func NewRedisInsecure

func NewRedisInsecure(host, port string, db int, dbPrefix string) (*Redis, error)

NewRedisInsecure instantiates a new insecure client

func NewRedisSecure

func NewRedisSecure(host, port, user, password string, db int, dbPrefix string) (*Redis, error)

NewRedisSecure instantiates a new secure TLS client

func (*Redis) Get

func (c *Redis) Get(ctx context.Context, key string, val any) error

func (*Redis) Has

func (c *Redis) Has(ctx context.Context, key string) (bool, error)

func (*Redis) Keys

func (c *Redis) Keys(ctx context.Context, pattern string) ([]string, error)

func (*Redis) Set

func (c *Redis) Set(ctx context.Context, key string, val any, ttl time.Duration) error