cachee

Documentation

Index

• type CCacheKvStore
  • func NewCCacheKvStore[V any](cc *ccache.Cache) *CCacheKvStore[V]
  • func (cc *CCacheKvStore[V]) Del(ctx context.Context, key string) error
  • func (cc *CCacheKvStore[V]) Get(ctx context.Context, key string) (v V, exist bool, err error)
  • func (cc *CCacheKvStore[V]) Set(ctx context.Context, key string, value V, expiration time.Duration) error
• type Encoder
  • func JsonEncoder[V any]() Encoder[V]
  • func MsgPackEncoder[V any]() Encoder[V]
• type FreeCacheKvStore
  • func NewFreeCacheKvStore[V any](fc *freecache.Cache, enc Encoder[V]) *FreeCacheKvStore[V]
  • func (fc *FreeCacheKvStore[V]) Del(ctx context.Context, key string) error
  • func (fc *FreeCacheKvStore[V]) Get(ctx context.Context, key string) (v V, exist bool, err error)
  • func (fc *FreeCacheKvStore[V]) Set(ctx context.Context, key string, value V, expiration time.Duration) error
• type KvItem
  • func (item *KvItem[V]) GetOrLoad(ctx context.Context) (v V, err error)
• type KvStore
• type RedisKvStore
  • func NewRedisKvStore[V any](c *redis.Client, enc Encoder[V]) *RedisKvStore[V]
  • func (r *RedisKvStore[V]) Del(ctx context.Context, key string) error
  • func (r *RedisKvStore[V]) Get(ctx context.Context, key string) (v V, exist bool, err error)
  • func (r *RedisKvStore[V]) Set(ctx context.Context, key string, value V, expiration time.Duration) error

Examples

• FreeCacheKvStore
• RedisKvStore

Types

type CCacheKvStore

type CCacheKvStore[V any] struct {
	Cache *ccache.Cache
}

func NewCCacheKvStore

func NewCCacheKvStore[V any](cc *ccache.Cache) *CCacheKvStore[V]

func (*CCacheKvStore[V]) Del

func (cc *CCacheKvStore[V]) Del(ctx context.Context, key string) error

func (*CCacheKvStore[V]) Get

func (cc *CCacheKvStore[V]) Get(ctx context.Context, key string) (v V, exist bool, err error)

func (*CCacheKvStore[V]) Set

func (cc *CCacheKvStore[V]) Set(ctx context.Context, key string, value V, expiration time.Duration) error

type Encoder

type Encoder[V any] struct {
	Encode func(V) ([]byte, error)
	Decode func(data []byte) (V, error)
}

func JsonEncoder

func JsonEncoder[V any]() Encoder[V]

func MsgPackEncoder

func MsgPackEncoder[V any]() Encoder[V]

type FreeCacheKvStore

type FreeCacheKvStore[V any] struct {
	Cache *freecache.Cache
	Enc   Encoder[V]
}

Example

store := NewFreeCacheKvStore(freecache.NewCache(32), MsgPackEncoder[string]())
ctx := context.TODO()

v, exist, err := store.Get(ctx, `name`)
fmt.Println(v == ``, exist, err)

err = store.Set(ctx, `name`, `alice`, time.Second)
fmt.Println(err)

v, exist, err = store.Get(ctx, `name`)
fmt.Println(v, exist, err)

time.Sleep(time.Second)
v, exist, err = store.Get(ctx, `name`)
fmt.Println(v == ``, exist, err)

Output:

true false <nil>
<nil>
alice true <nil>
true false <nil>

func NewFreeCacheKvStore

func NewFreeCacheKvStore[V any](fc *freecache.Cache, enc Encoder[V]) *FreeCacheKvStore[V]

func (*FreeCacheKvStore[V]) Del

func (fc *FreeCacheKvStore[V]) Del(ctx context.Context, key string) error

func (*FreeCacheKvStore[V]) Get

func (fc *FreeCacheKvStore[V]) Get(ctx context.Context, key string) (v V, exist bool, err error)

func (*FreeCacheKvStore[V]) Set

func (fc *FreeCacheKvStore[V]) Set(ctx context.Context, key string, value V, expiration time.Duration) error

type KvItem

type KvItem[V any] struct {
	Key        string
	Expiration time.Duration

	Load func() (V, error)
	// contains filtered or unexported fields
}

func (*KvItem[V]) GetOrLoad

func (item *KvItem[V]) GetOrLoad(ctx context.Context) (v V, err error)

type KvStore

type KvStore[K comparable, V any] interface {
	Get(ctx context.Context, key K) (v V, exist bool, err error)
	Set(ctx context.Context, key K, value V, expiration time.Duration) error
	Del(ctx context.Context, key K) error
}

type RedisKvStore

type RedisKvStore[V any] struct {
	Client *redis.Client
	Enc    Encoder[V]
}

Example

db, mock := redismock.NewClientMock()

store := NewRedisKvStore(db, JsonEncoder[string]())
ctx := context.TODO()

mock.ExpectGet(`name`).RedisNil()
v, exist, err := store.Get(ctx, `name`)
fmt.Println(v == ``, exist, err)

cmd1 := mock.ExpectSet(`name`, []byte(`"alice"`), time.Second)
cmd1.SetVal("")
cmd1.SetErr(nil)
err = store.Set(ctx, `name`, `alice`, time.Second)
fmt.Println(err)

cmd2 := mock.ExpectGet(`name`)
cmd2.SetVal(`"alice"`)
cmd2.SetErr(nil)
v, exist, err = store.Get(ctx, `name`)
fmt.Println(v, exist, err)

time.Sleep(time.Second)
mock.ExpectGet(`name`).RedisNil()
v, exist, err = store.Get(ctx, `name`)
fmt.Println(v == ``, exist, err)

Output:

true false <nil>
<nil>
alice true <nil>
true false <nil>

func NewRedisKvStore

func NewRedisKvStore[V any](c *redis.Client, enc Encoder[V]) *RedisKvStore[V]

func (*RedisKvStore[V]) Del

func (r *RedisKvStore[V]) Del(ctx context.Context, key string) error

func (*RedisKvStore[V]) Get

func (r *RedisKvStore[V]) Get(ctx context.Context, key string) (v V, exist bool, err error)

func (*RedisKvStore[V]) Set

func (r *RedisKvStore[V]) Set(ctx context.Context, key string, value V, expiration time.Duration) error