cache

Documentation

Index

• type Store
  • func NewStore[T interface{}](ctx context.Context, opts ...StoreOption[T]) *Store[T]
  • func (s *Store[T]) Delete(key string)
  • func (s *Store[T]) Flush()
  • func (s *Store[T]) GetOrSet(key string, getValue func() (T, error)) (T, error)
  • func (s *Store[T]) GetOrSetWithTTL(key string, getValue func() (T, error), ttl time.Duration) (T, error)
  • func (s *Store[T]) ResetRefresher(interval time.Duration)
  • func (s *Store[T]) StopRefresher()
• type StoreOption
  • func WithDefaultTTL[T interface{}](ttl time.Duration) StoreOption[T]
  • func WithRefreshInterval[T interface{}](interval time.Duration) StoreOption[T]

Types

type Store

type Store[T interface{}] struct {
	// contains filtered or unexported fields
}

func NewStore

func NewStore[T interface{}](ctx context.Context, opts ...StoreOption[T]) *Store[T]

func (*Store[T]) Delete

func (s *Store[T]) Delete(key string)

func (*Store[T]) Flush

func (s *Store[T]) Flush()

func (*Store[T]) GetOrSet

func (s *Store[T]) GetOrSet(key string, getValue func() (T, error)) (T, error)

GetOrSet gets cache value T, or set the value T that returns getValue. If getValue does not return err, cache the value T.

func (*Store[T]) GetOrSetWithTTL

func (s *Store[T]) GetOrSetWithTTL(key string, getValue func() (T, error), ttl time.Duration) (T, error)

GetOrSet gets cache value T, or set the value T that returns getValue with TTL. If getValue does not return err, cache the value T.

func (*Store[T]) ResetRefresher

func (s *Store[T]) ResetRefresher(interval time.Duration)

func (*Store[T]) StopRefresher

func (s *Store[T]) StopRefresher()

type StoreOption

type StoreOption[T interface{}] func(*Store[T])

func WithDefaultTTL

func WithDefaultTTL[T interface{}](ttl time.Duration) StoreOption[T]

func WithRefreshInterval

func WithRefreshInterval[T interface{}](interval time.Duration) StoreOption[T]