pine

README

pine

pine is a runtime cache tool

Install

go get github.com/johnhaha/pine@v0.0.9

Documentation

Index

• Variables
• func InitCache(ctx context.Context, eviction time.Duration) error
• func Remove(id string)
• type CacheData
  • func Get[T any](id string, withCache bool, execution func() (T, error)) (*CacheData[T], error)
  • func SingleRun[T any](key string, execution func() (T, error)) (*CacheData[T], error)
  • func (data *CacheData[T]) Decode(cache []byte) error
  • func (data *CacheData[T]) Encode() ([]byte, error)
• type CacheLife
  • func (life *CacheLife) Expired() bool
  • func (life *CacheLife) Update()
• type CachedData
  • func NewCachedData[T any](lifeTime int64) *CachedData[T]
  • func (data *CachedData[T]) Clear()
  • func (data *CachedData[T]) Get(onExpire func() (*T, error)) (*T, error)
  • func (data *CachedData[T]) Set(d *T)
• type CachedList
  • func NewCachedList[T any](lifeTime int64, capacity int) *CachedList[T]
  • func (list *CachedList[T]) Append(data []T, at int)
  • func (list *CachedList[T]) Clear()
  • func (list *CachedList[T]) Count() (page int, num int)
  • func (list *CachedList[T]) First() []T
  • func (list *CachedList[T]) GetPage(page int, getData func(page int) ([]T, error)) (listData []T, err error)
  • func (list *CachedList[T]) Last() []T
  • func (list *CachedList[T]) Length() int
• type ExpireError
  • func NewExpireError() *ExpireError
  • func (e *ExpireError) Error() string
• type ListElement
• type PageOutOfRangeError
  • func NewPageOutOfRangeError() *PageOutOfRangeError
  • func (e *PageOutOfRangeError) Error() string

Variables

var Cache *bigcache.BigCache

Functions

func InitCache

func InitCache(ctx context.Context, eviction time.Duration) error

normally 10*time.Minute for eviction

func Remove

func Remove(id string)

remove cache with id

Types

type CacheData

type CacheData[T any] struct {
	Data      T
	FromCache bool
}

func Get

func Get[T any](id string, withCache bool, execution func() (T, error)) (*CacheData[T], error)

get from cache if exists, store cache with execution if not exists

func SingleRun

func SingleRun[T any](key string, execution func() (T, error)) (*CacheData[T], error)

func (*CacheData[T]) Decode

func (data *CacheData[T]) Decode(cache []byte) error

func (*CacheData[T]) Encode

func (data *CacheData[T]) Encode() ([]byte, error)

type CacheLife

type CacheLife struct {
	Lifetime  int64
	UpdatedAt int64
}

func (*CacheLife) Expired

func (life *CacheLife) Expired() bool

func (*CacheLife) Update

func (life *CacheLife) Update()

type CachedData

type CachedData[T any] struct {
	Data *T
	CacheLife
}

func NewCachedData

func NewCachedData[T any](lifeTime int64) *CachedData[T]

func (*CachedData[T]) Clear

func (data *CachedData[T]) Clear()

func (*CachedData[T]) Get

func (data *CachedData[T]) Get(onExpire func() (*T, error)) (*T, error)

func (*CachedData[T]) Set

func (data *CachedData[T]) Set(d *T)

type CachedList

type CachedList[T any] struct {
	Data [][]T
	CacheLife
	Capacity int
	sync.RWMutex
}

func NewCachedList

func NewCachedList[T any](lifeTime int64, capacity int) *CachedList[T]

func (*CachedList[T]) Append

func (list *CachedList[T]) Append(data []T, at int)

func (*CachedList[T]) Clear

func (list *CachedList[T]) Clear()

clear cached list

func (*CachedList[T]) Count

func (list *CachedList[T]) Count() (page int, num int)

return last element of cached list

func (*CachedList[T]) First

func (list *CachedList[T]) First() []T

return first element of cached list

func (*CachedList[T]) GetPage

func (list *CachedList[T]) GetPage(page int, getData func(page int) ([]T, error)) (listData []T, err error)

get list from specific index

func (*CachedList[T]) Last

func (list *CachedList[T]) Last() []T

return last element of cached list

func (*CachedList[T]) Length

func (list *CachedList[T]) Length() int

get length of cached list

type ExpireError

type ExpireError struct {
}

func NewExpireError

func NewExpireError() *ExpireError

func (*ExpireError) Error

func (e *ExpireError) Error() string

type ListElement

type ListElement interface {
	GetUID() string
}

type PageOutOfRangeError

type PageOutOfRangeError struct {
}

func NewPageOutOfRangeError

func NewPageOutOfRangeError() *PageOutOfRangeError

func (*PageOutOfRangeError) Error

func (e *PageOutOfRangeError) Error() string