trfreecache

README

trcache FreeCache

This is a trcache wrapper for FreeCache.

Info

FreeCache library

info
Generics	No
Key types	[]byte
Value types	[]byte
TTL	Yes

wrapper

info
Default codec	GOBCodec
Default key codec	StringKeyCodec

Installation

go get github.com/rrgmc/trcache/cache/freecache

Documentation

Index

• func WithDefaultDuration[K comparable, V any](duration time.Duration) trcache.RootOption
• func WithKeyCodec[K comparable, V any](keyCodec trcache.KeyCodec[K]) trcache.RootOption
• func WithValidator[K comparable, V any](validator trcache.Validator[V]) trcache.RootOption
• func WithValueCodec[K comparable, V any](valueCodec trcache.Codec[V]) trcache.RootOption
• type Cache
  • func New[K comparable, V any](cache *freecache.Cache, options ...trcache.RootOption) (*Cache[K, V], error)
  • func (c *Cache[K, V]) Delete(ctx context.Context, key K, options ...trcache.DeleteOption) error
  • func (c *Cache[K, V]) Get(ctx context.Context, key K, options ...trcache.GetOption) (V, error)
  • func (c *Cache[K, V]) Handle() *freecache.Cache
  • func (c *Cache[K, V]) Name() string
  • func (c *Cache[K, V]) Set(ctx context.Context, key K, value V, options ...trcache.SetOption) error
• type RefreshCache
  • func NewRefresh[K comparable, V any](cache *freecache.Cache, options ...trcache.RootOption) (*RefreshCache[K, V], error)
  • func (c *RefreshCache[K, V]) GetOrRefresh(ctx context.Context, key K, options ...trcache.RefreshOption) (V, error)

Functions

func WithDefaultDuration

func WithDefaultDuration[K comparable, V any](duration time.Duration) trcache.RootOption

func WithKeyCodec

func WithKeyCodec[K comparable, V any](keyCodec trcache.KeyCodec[K]) trcache.RootOption

func WithValidator

func WithValidator[K comparable, V any](validator trcache.Validator[V]) trcache.RootOption

func WithValueCodec

func WithValueCodec[K comparable, V any](valueCodec trcache.Codec[V]) trcache.RootOption

Types

type Cache

type Cache[K comparable, V any] struct {
	// contains filtered or unexported fields
}

func New

func New[K comparable, V any](cache *freecache.Cache,
	options ...trcache.RootOption) (*Cache[K, V], error)

func (*Cache[K, V]) Delete

func (c *Cache[K, V]) Delete(ctx context.Context, key K,
	options ...trcache.DeleteOption) error

func (*Cache[K, V]) Get

func (c *Cache[K, V]) Get(ctx context.Context, key K,
	options ...trcache.GetOption) (V, error)

func (*Cache[K, V]) Handle

func (c *Cache[K, V]) Handle() *freecache.Cache

func (*Cache[K, V]) Name

func (c *Cache[K, V]) Name() string

func (*Cache[K, V]) Set

func (c *Cache[K, V]) Set(ctx context.Context, key K, value V,
	options ...trcache.SetOption) error

type RefreshCache

type RefreshCache[K comparable, V any] struct {
	*Cache[K, V]
	// contains filtered or unexported fields
}

func NewRefresh

func NewRefresh[K comparable, V any](cache *freecache.Cache,
	options ...trcache.RootOption) (*RefreshCache[K, V], error)

func (*RefreshCache[K, V]) GetOrRefresh

func (c *RefreshCache[K, V]) GetOrRefresh(ctx context.Context, key K, options ...trcache.RefreshOption) (V, error)