cache

Documentation

Index

• Variables
• type Cache
  • func New(dbPath string) (*Cache, error)
  • func (c *Cache) Delete(key string) error
  • func (c *Cache) DeleteAllByTag(tagName string) error
  • func (c *Cache) Get(key string) ([]byte, error)
  • func (c *Cache) GetAllByTag(tag string) ([][]byte, error)
  • func (c *Cache) Set(key string, value []byte) error
  • func (c *Cache) SetWithTags(key string, value []byte, tags ...string) error
  • func (c *Cache) Stop() error

Variables

var (
	ErrNotFound = errors.New("item not found")
)

Types

type Cache

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

func New

func New(dbPath string) (*Cache, error)

New returns a new Cache that stores its data in dbPath.

func (*Cache) Delete

func (c *Cache) Delete(key string) error

Delete deletes the item identified by key in the cache. No error is returned if the item does not exist in the cache.

func (*Cache) DeleteAllByTag

func (c *Cache) DeleteAllByTag(tagName string) error

DeleteAllByTag deletes all items in the cache that have been tagged by tagName. Deletes an item even if multiple tags refer to it.

func (*Cache) Get

func (c *Cache) Get(key string) ([]byte, error)

Get returns the item identified by key from the cache. It returns ErrNotFound if the item doesn't exist in the cache.

func (*Cache) GetAllByTag

func (c *Cache) GetAllByTag(tag string) ([][]byte, error)

GetAllByTag returns the values of all items tagged with tag.

func (*Cache) Set

func (c *Cache) Set(key string, value []byte) error

Set writes the item identified by key with value to the cache.

func (*Cache) SetWithTags

func (c *Cache) SetWithTags(key string, value []byte, tags ...string) error

SetWithTags adds the item identified by key with value to the cache. One or more tags can be passed to tag the item.

func (*Cache) Stop

func (c *Cache) Stop() error

Stop closes the connection to the underlying SQLite database.

Users of a Cache should call this method to free up resources and goroutines.