cache

README

Cache

Installation

Install Cache

go get -u github.com/gowool/cache

Install Fx Module

go get -u github.com/gowool/cache/fx

Install Redis Backend

go get -u github.com/gowool/rediscachebe

License

Distributed under MIT License, please see license file within the code for more details.

Documentation

Index

• Variables
• type Backend
• type Cache
  • func NewCache(backend Backend, ttl time.Duration) Cache
• type ChainBackend
  • func NewChainBackend(backends ...Backend) *ChainBackend
  • func (b *ChainBackend) Del(ctx context.Context, key string) (err error)
  • func (b *ChainBackend) DelAll(ctx context.Context) (err error)
  • func (b *ChainBackend) Get(ctx context.Context, key string) ([]byte, error)
  • func (b *ChainBackend) Set(ctx context.Context, key string, value []byte, ttl time.Duration) (err error)
• type FreeBackend
  • func NewFreeBackend(size int) *FreeBackend
  • func (b *FreeBackend) Del(_ context.Context, key string) error
  • func (b *FreeBackend) DelAll(context.Context) error
  • func (b *FreeBackend) Get(_ context.Context, key string) ([]byte, error)
  • func (b *FreeBackend) Set(_ context.Context, key string, value []byte, ttl time.Duration) error
• type Item
  • func (i Item) Expired() bool
• type MapBackend
  • func NewMapBackend(cleanupInterval time.Duration) *MapBackend
  • func NewMapBackendFrom(cleanupInterval time.Duration, items map[string]Item) *MapBackend
  • func (b *MapBackend) Del(_ context.Context, key string) error
  • func (b *MapBackend) DelAll(context.Context) error
  • func (b *MapBackend) DelExpired()
  • func (b *MapBackend) Get(_ context.Context, key string) ([]byte, error)
  • func (b *MapBackend) Items() map[string]Item
  • func (b *MapBackend) Set(_ context.Context, key string, value []byte, ttl time.Duration) error
• type NopCache
  • func (*NopCache) DelAll(context.Context) error
  • func (*NopCache) DelByKey(context.Context, string) error
  • func (*NopCache) DelByTag(context.Context, string) error
  • func (*NopCache) Get(context.Context, string, any) error
  • func (*NopCache) Set(context.Context, string, any, ...string) error

Variables

var ErrNotFound = freecache.ErrNotFound

Types

type Backend

type Backend interface {
	Get(ctx context.Context, key string) ([]byte, error)
	Set(ctx context.Context, key string, value []byte, ttl time.Duration) error
	Del(ctx context.Context, key string) error
	DelAll(ctx context.Context) error
}

type Cache

type Cache interface {
	Set(ctx context.Context, key string, value any, tags ...string) error
	Get(ctx context.Context, key string, value any) error
	DelByKey(ctx context.Context, key string) error
	DelByTag(ctx context.Context, tag string) error
	DelAll(ctx context.Context) error
}

func NewCache

func NewCache(backend Backend, ttl time.Duration) Cache

type ChainBackend

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

func NewChainBackend

func NewChainBackend(backends ...Backend) *ChainBackend

func (*ChainBackend) Del

func (b *ChainBackend) Del(ctx context.Context, key string) (err error)

func (*ChainBackend) DelAll

func (b *ChainBackend) DelAll(ctx context.Context) (err error)

func (*ChainBackend) Get

func (b *ChainBackend) Get(ctx context.Context, key string) ([]byte, error)

func (*ChainBackend) Set

func (b *ChainBackend) Set(ctx context.Context, key string, value []byte, ttl time.Duration) (err error)

type FreeBackend

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

func NewFreeBackend

func NewFreeBackend(size int) *FreeBackend

func (*FreeBackend) Del

func (b *FreeBackend) Del(_ context.Context, key string) error

func (*FreeBackend) DelAll

func (b *FreeBackend) DelAll(context.Context) error

func (*FreeBackend) Get

func (b *FreeBackend) Get(_ context.Context, key string) ([]byte, error)

func (*FreeBackend) Set

func (b *FreeBackend) Set(_ context.Context, key string, value []byte, ttl time.Duration) error

type Item

type Item struct {
	Value      []byte
	Expiration int64
}

func (Item) Expired

func (i Item) Expired() bool

type MapBackend

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

func NewMapBackend

func NewMapBackend(cleanupInterval time.Duration) *MapBackend

func NewMapBackendFrom

func NewMapBackendFrom(cleanupInterval time.Duration, items map[string]Item) *MapBackend

func (*MapBackend) Del

func (b *MapBackend) Del(_ context.Context, key string) error

func (*MapBackend) DelAll

func (b *MapBackend) DelAll(context.Context) error

func (*MapBackend) DelExpired

func (b *MapBackend) DelExpired()

func (*MapBackend) Get

func (b *MapBackend) Get(_ context.Context, key string) ([]byte, error)

func (*MapBackend) Items

func (b *MapBackend) Items() map[string]Item

func (*MapBackend) Set

func (b *MapBackend) Set(_ context.Context, key string, value []byte, ttl time.Duration) error

type NopCache

type NopCache struct{}

func (*NopCache) DelAll

func (*NopCache) DelAll(context.Context) error

func (*NopCache) DelByKey

func (*NopCache) DelByKey(context.Context, string) error

func (*NopCache) DelByTag

func (*NopCache) DelByTag(context.Context, string) error

func (*NopCache) Get

func (*NopCache) Get(context.Context, string, any) error

func (*NopCache) Set

func (*NopCache) Set(context.Context, string, any, ...string) error