sweet

Documentation

Index

• Variables
• type Cache
  • func NewCache[V any](back SimpleCache, now func() time.Time) *Cache[V]
  • func (c Cache[V]) Clear(ctx context.Context)
  • func (c Cache[V]) Get(ctx context.Context, key any) (V, bool)
  • func (c Cache[V]) GetOrProvide(ctx context.Context, key any, valueProvider ValueProvider[V]) (V, bool)
  • func (c Cache[V]) GetOrProvideAsync(ctx context.Context, key any, valueProvider ValueProvider[V], defaultValue V) (V, bool)
  • func (c Cache[V]) Remove(ctx context.Context, key any)
• type CacheItem
• type CacheKeyGenerator
  • func NewGlobalCacheKeyGenerator(namespace string, cacheName string, cacheKeySeparator string, key any) (CacheKeyGenerator, error)
  • func NewGlobalCacheKeyGeneratorFromPrefix(prefix string, key any) (CacheKeyGenerator, error)
• type CacheMonitoring
• type Cacher
• type GlobalCacheKeyGenerator
  • func (g *GlobalCacheKeyGenerator) GetCacheKey() string
• type GlobalKeysCache
  • func NewGlobalKeysCache[V any](namespace string, cacheName string, cacheKeySeparator string, back Cacher[V]) *GlobalKeysCache[V]
  • func (t GlobalKeysCache[V]) Clear(ctx context.Context)
  • func (t GlobalKeysCache[V]) Get(ctx context.Context, key any) (V, bool)
  • func (t GlobalKeysCache[V]) GetOrProvide(ctx context.Context, key any, valueProvider ValueProvider[V]) (V, bool)
  • func (t GlobalKeysCache[V]) GetOrProvideAsync(ctx context.Context, key any, valueProvider ValueProvider[V], defaultValue V) (V, bool)
  • func (t GlobalKeysCache[V]) Remove(ctx context.Context, key any)
• type NopCacheMonitoring
  • func (n NopCacheMonitoring) ClearFailed(ctx context.Context)
  • func (n NopCacheMonitoring) GetFailed(ctx context.Context, key any, err error)
  • func (n NopCacheMonitoring) Hit(ctx context.Context, key any)
  • func (n NopCacheMonitoring) Miss(ctx context.Context, key any)
  • func (n NopCacheMonitoring) PutFailed(ctx context.Context, key any, err error)
  • func (n NopCacheMonitoring) RemoveFailed(ctx context.Context, key any)
• type SimpleCache
• type SimpleValueProvider
• type TwoLevelCache
  • func NewTwoLevelCache[V any](front Cacher[V], back Cacher[V]) *TwoLevelCache[V]
  • func (t TwoLevelCache[V]) Clear(ctx context.Context)
  • func (t TwoLevelCache[V]) Get(ctx context.Context, key any) (V, bool)
  • func (t TwoLevelCache[V]) GetOrProvide(ctx context.Context, key any, valueProvider ValueProvider[V]) (V, bool)
  • func (t TwoLevelCache[V]) GetOrProvideAsync(ctx context.Context, key any, valueProvider ValueProvider[V], defaultValue V) (V, bool)
  • func (t TwoLevelCache[V]) Remove(ctx context.Context, key any)
• type ValueProvider
  • func FixedTTLProvider[V any](defaultActualTTL time.Duration, defaultUsableTTL time.Duration, ...) ValueProvider[V]
  • func SimpleFixedTTLProvider[V any](defaultUsableTTL time.Duration, defaultUsableNegativeTTL time.Duration, ...) ValueProvider[V]
  • func (p *ValueProvider[V]) WithRemoteCache(remoteCache Cacher[V], baseProvider ValueProvider[V]) ValueProvider[V]

Variables

var InvalidCacheKeyErr = errors.New("cache key should be string or implement \"GetCacheKey() string\" method")

Types

type Cache

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

func NewCache

func NewCache[V any](back SimpleCache, now func() time.Time) *Cache[V]

func (Cache[V]) Clear

func (c Cache[V]) Clear(ctx context.Context)

func (Cache[V]) Get

func (c Cache[V]) Get(ctx context.Context, key any) (V, bool)

func (Cache[V]) GetOrProvide

func (c Cache[V]) GetOrProvide(ctx context.Context, key any, valueProvider ValueProvider[V]) (V, bool)

func (Cache[V]) GetOrProvideAsync

func (c Cache[V]) GetOrProvideAsync(
	ctx context.Context,
	key any,
	valueProvider ValueProvider[V],
	defaultValue V,
) (V, bool)

func (Cache[V]) Remove

func (c Cache[V]) Remove(ctx context.Context, key any)

type CacheItem

type CacheItem[V any] struct {
	// contains filtered or unexported fields
}

type CacheKeyGenerator

type CacheKeyGenerator interface {
	GetCacheKey() string
}

func NewGlobalCacheKeyGenerator

func NewGlobalCacheKeyGenerator(namespace string, cacheName string, cacheKeySeparator string, key any) (CacheKeyGenerator, error)

func NewGlobalCacheKeyGeneratorFromPrefix

func NewGlobalCacheKeyGeneratorFromPrefix(prefix string, key any) (CacheKeyGenerator, error)

type CacheMonitoring

type CacheMonitoring interface {
	Miss(ctx context.Context, key any)
	Hit(ctx context.Context, key any)
	GetFailed(ctx context.Context, key any, err error)
	PutFailed(ctx context.Context, key any, err error)
	RemoveFailed(ctx context.Context, key any)
	ClearFailed(ctx context.Context)
}

type Cacher

type Cacher[V any] interface {
	GetOrProvide(ctx context.Context, key any, valueProvider ValueProvider[V]) (V, bool)
	GetOrProvideAsync(ctx context.Context, key any, valueProvider ValueProvider[V], defaultValue V) (V, bool)
	Get(ctx context.Context, key any) (V, bool)
	Remove(ctx context.Context, key any)
	Clear(ctx context.Context)
}

type GlobalCacheKeyGenerator

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

func (*GlobalCacheKeyGenerator) GetCacheKey

func (g *GlobalCacheKeyGenerator) GetCacheKey() string

type GlobalKeysCache

type GlobalKeysCache[V any] struct {
	// contains filtered or unexported fields
}

func NewGlobalKeysCache

func NewGlobalKeysCache[V any](namespace string, cacheName string, cacheKeySeparator string, back Cacher[V]) *GlobalKeysCache[V]

func (GlobalKeysCache[V]) Clear

func (t GlobalKeysCache[V]) Clear(ctx context.Context)

func (GlobalKeysCache[V]) Get

func (t GlobalKeysCache[V]) Get(ctx context.Context, key any) (V, bool)

func (GlobalKeysCache[V]) GetOrProvide

func (t GlobalKeysCache[V]) GetOrProvide(ctx context.Context, key any, valueProvider ValueProvider[V]) (V, bool)

func (GlobalKeysCache[V]) GetOrProvideAsync

func (t GlobalKeysCache[V]) GetOrProvideAsync(ctx context.Context, key any, valueProvider ValueProvider[V], defaultValue V) (V, bool)

func (GlobalKeysCache[V]) Remove

func (t GlobalKeysCache[V]) Remove(ctx context.Context, key any)

type NopCacheMonitoring

type NopCacheMonitoring struct {
}

func (NopCacheMonitoring) ClearFailed

func (n NopCacheMonitoring) ClearFailed(ctx context.Context)

func (NopCacheMonitoring) GetFailed

func (n NopCacheMonitoring) GetFailed(ctx context.Context, key any, err error)

func (NopCacheMonitoring) Hit

func (n NopCacheMonitoring) Hit(ctx context.Context, key any)

func (NopCacheMonitoring) Miss

func (n NopCacheMonitoring) Miss(ctx context.Context, key any)

func (NopCacheMonitoring) PutFailed

func (n NopCacheMonitoring) PutFailed(ctx context.Context, key any, err error)

func (NopCacheMonitoring) RemoveFailed

func (n NopCacheMonitoring) RemoveFailed(ctx context.Context, key any)

type SimpleCache

type SimpleCache interface {
	// Set adds a key-value pair to the cache.
	// Returns false if key was not set because of some reason
	Set(key any, value any) bool

	// Get retrieves a value from the cache by its key.
	Get(key any) (any, bool)

	// Remove removes a key-value pair from the cache.
	Remove(key any)

	// Clear clears all key-value pairs from the cache.
	Clear()

	// SetWithTTL works like Set but adds a key-value pair to the cache that will expire after the specified TTL
	// (time to live) has passed. A zero value means the value never expires, which is identical to calling Set.
	// A negative value is a no-op and the value is discarded.
	SetWithTTL(key any, value any, ttl time.Duration) bool
}

SimpleCache is an interface for a simple cache that can store key-value pairs.

type SimpleValueProvider

type SimpleValueProvider[V any] func(ctx context.Context, key any) (V, error)

type TwoLevelCache

type TwoLevelCache[V any] struct {
	// contains filtered or unexported fields
}

func NewTwoLevelCache

func NewTwoLevelCache[V any](front Cacher[V], back Cacher[V]) *TwoLevelCache[V]

func (TwoLevelCache[V]) Clear

func (t TwoLevelCache[V]) Clear(ctx context.Context)

func (TwoLevelCache[V]) Get

func (t TwoLevelCache[V]) Get(ctx context.Context, key any) (V, bool)

func (TwoLevelCache[V]) GetOrProvide

func (t TwoLevelCache[V]) GetOrProvide(ctx context.Context, key any, valueProvider ValueProvider[V]) (V, bool)

func (TwoLevelCache[V]) GetOrProvideAsync

func (t TwoLevelCache[V]) GetOrProvideAsync(ctx context.Context, key any, valueProvider ValueProvider[V], defaultValue V) (V, bool)

func (TwoLevelCache[V]) Remove

func (t TwoLevelCache[V]) Remove(ctx context.Context, key any)

type ValueProvider

type ValueProvider[V any] func(ctx context.Context, key any) (ok bool, val V, actualTTL time.Duration, usableTTL time.Duration)

ValueProvider is a function that provides a value for a given key, along with the actual and usable TTLs.

The function takes a key of type K and returns a value of type V, along with the actual TTL and usable TTL, or an error if the value could not be provided.

Context should be used by provider to properly process cancellation, e.g. because of timeout.

func FixedTTLProvider

func FixedTTLProvider[V any](
	defaultActualTTL time.Duration,
	defaultUsableTTL time.Duration,
	defaultActualNegativeTTL time.Duration,
	defaultUsableNegativeTTL time.Duration,
	simpleProvider SimpleValueProvider[V],
) ValueProvider[V]

func SimpleFixedTTLProvider

func SimpleFixedTTLProvider[V any](
	defaultUsableTTL time.Duration,
	defaultUsableNegativeTTL time.Duration,
	f func(ctx context.Context, key any) (V, error),
) ValueProvider[V]

func (*ValueProvider[V]) WithRemoteCache

func (p *ValueProvider[V]) WithRemoteCache(
	remoteCache Cacher[V],
	baseProvider ValueProvider[V],
) ValueProvider[V]