cache

Documentation

Index

• type Cache
  • func New[K comparable, V any](config Config) (Cache[K, V], error)
• type Config
• type TTL

Types

type Cache

type Cache[K comparable, V any] interface {
	// Get - get data(Value) for Key (return Value if key doesn't expire)
	Get(K) (V, bool)

	// Set - set data(Value) for Key (without TTL, not expired)
	Set(K, V)

	// SetWithTTL - set data(Value) for Key (with TTL or when expired)
	SetWithTTL(K, V, TTL)

	// SetTTL - set TTL for Key
	SetTTL(K, TTL)

	// TryGetOrInvokeLambda - try Get(Key) if not found, exec Lambda and if success store Value by Set func
	TryGetOrInvokeLambda(K, lambda[K, V]) (V, error)

	// Delete - delete Key
	Delete(K)

	// CleanAll - delete all data in storage (all Key)
	CleanAll()
}

Cache - interface of cache.

func New

func New[K comparable, V any](config Config) (Cache[K, V], error)

New "Constructor" of Cache

type Config

type Config struct {
	DefaultTTL string `yaml:"default_ttl"`

	CustomCacheConfig map[string]any `yaml:"customCacheConfig"`
}

Config - for cache.

type TTL

type TTL = struct {
	TTL      time.Duration // PREFER(more important) THAN ExpireAt
	ExpireAt time.Time
}

TTL - struct describe TTL use cases for cache.