cache

Documentation

Overview

Package cache implements a redis-based page cache for pkgsite.

Index

• type Cache
  • func New(client *redis.Client) *Cache
  • func (c *Cache) Clear(ctx context.Context) (err error)
  • func (c *Cache) Delete(ctx context.Context, keys ...string) (err error)
  • func (c *Cache) DeletePrefix(ctx context.Context, prefix string) (err error)
  • func (c *Cache) Get(ctx context.Context, key string) (value []byte, err error)
  • func (c *Cache) Put(ctx context.Context, key string, data []byte, ttl time.Duration) (err error)

Types

type Cache

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

Cache is a Redis-based cache.

func New

func New(client *redis.Client) *Cache

New creates a new Cache using the given Redis client.

func (*Cache) Clear

func (c *Cache) Clear(ctx context.Context) (err error)

Clear deletes all entries from the cache.

func (*Cache) Delete

func (c *Cache) Delete(ctx context.Context, keys ...string) (err error)

Delete deletes the given keys. It does not return an error if a key does not exist.

func (*Cache) DeletePrefix

func (c *Cache) DeletePrefix(ctx context.Context, prefix string) (err error)

DeletePrefix deletes all keys beginning with prefix.

func (*Cache) Get

func (c *Cache) Get(ctx context.Context, key string) (value []byte, err error)

Get returns the value for key, or nil if the key does not exist.

func (*Cache) Put

func (c *Cache) Put(ctx context.Context, key string, data []byte, ttl time.Duration) (err error)

Put inserts the key with the given data and time-to-live.