cache

README

cache

Go package for dealing with caching. Maybe not so fast.

Requires Go 1.9+ since the package is using type aliases.

Installation

$ go get -u github.com/frozzare/go-cache

Stores

• Memory
• Redis
• Bolt

More cache stores can be implemented by using the provided store interface.

Example

package main

import (
	"log"

	"github.com/frozzare/go-cache"
	"github.com/frozzare/go-cache/store/redis"
)

func main() {
	c := cache.New(redis.NewStore(&redis.Options{
		Addr: "localhost:6379",
	}))

	if err := c.Set("name", "go"); err != nil {
		log.Fatal(err)
	}

	v, err := c.Get("name")
	if err != nil {
		log.Fatal(err)
	}

	log.Println(v)
}

License

MIT © Fredrik Forsmo

Documentation

Index

• type Cache
  • func New(store store.Store) *Cache
  • func (c *Cache) Flush() error
  • func (c *Cache) Get(key string) (interface{}, error)
  • func (c *Cache) Remove(key string) error
  • func (c *Cache) Result(key string, v interface{}) error
  • func (c *Cache) Set(key string, value interface{}, expiration ...time.Duration) error

Types

type Cache

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

Cache represents the cache struct.

func New

func New(store store.Store) *Cache

New with the given options.

func (*Cache) Flush

func (c *Cache) Flush() error

Flush remove all items from the cache.

func (*Cache) Get

func (c *Cache) Get(key string) (interface{}, error)

Get will retrive a item from the cache.

func (*Cache) Remove

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

Remove will remove a item from the cache.

func (*Cache) Result

func (c *Cache) Result(key string, v interface{}) error

Result will retrieve a item from the cache and stores the result in the value pointed to by v.

func (*Cache) Set

func (c *Cache) Set(key string, value interface{}, expiration ...time.Duration) error

Set will store a item in the cache.