cache

type Cache ¶

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

Cache represents a cache.

func New(opts ...CacheOption) *Cache

func (c *Cache) Close()

func (c *Cache) Ping(ctx context.Context) error

func (c *Cache) Start(ctx context.Context) error

type CacheInstance ¶

type CacheInstance[T any] interface {
	// Get value from cache. If value is not found, it will return default value.
	Get(ctx context.Context, key string, opts ...ItemOption[T]) (T, error)
	// Pop returns value from tha cache and deletes it. If value is not found, it will return ErrKeyNotFound error.
	Pop(ctx context.Context, key string) (T, error)
	// Set value in cache.
	Set(ctx context.Context, key string, value T, opts ...ItemOption[T]) error
	// Delete value from cache.
	Delete(ctx context.Context, key string) error
}

CacheInstance represents a cache instance.

func Create[T any](cache *Cache, name string, opts ...CacheOption) (CacheInstance[T], error)

func Get[T any](cache *Cache, name string) (CacheInstance[T], error)

type CacheInstanceCloser ¶

type CacheInstanceCloser interface {
	// Close cache instance.
	Close()
}

CacheInstanceCloser represents a cache instance close method.

type CacheInstancePinger ¶

type CacheInstancePinger interface {
	Ping(ctx context.Context) error
}

CacheInstancePinger represents a cache instance ping method.

type CacheOption ¶

type CacheOption interface {
	// contains filtered or unexported methods
}

CacheOption is an option for the cache instance.

type CacheType ¶

type CacheType string

CacheType represents a cache type.

const (
	// MemoryCache store data in memory.
	MemoryCache CacheType = "memory"
	// RedisCache store data in Redis database.
	RedisCache CacheType = "redis"
	// RedisClusterCache store data in Redis database cluster.
	RedisClusterCache CacheType = "redis-cluster"
)

type ConnectionPassword ¶

type ConnectionPassword string

ConnectionString is a connection password for the cache instance.

type ConnectionString ¶

type ConnectionString string

ConnectionString is a connection string for the cache instance.

type DefaultTTL ¶

type DefaultTTL time.Duration

DefaultTTL is an default TTL for items in cache instance.

type ErrKeyNotFound ¶

type ErrKeyNotFound struct {
	Key string
}

func (e ErrKeyNotFound) Error() string

type Instrumenter ¶ added in v0.7.0

type Instrumenter instrumenter.Instrumenter

Instrumenter is a function that instruments cache operations.

type ItemOption ¶

type ItemOption[T any] interface {
	// contains filtered or unexported methods
}

ItemOption is an option for the cached item.

type KeyPrefix ¶

type KeyPrefix string

KeyPrefix is a prefix for the cache keys.

type Loader ¶

type Loader func(ctx context.Context, key string) (any, error)

Loader is a function that loads data when cache key is missing.

WARNING: it's not guaranteed that the function will be called only once.

type TTL ¶

type TTL[T any] time.Duration

TTL represents time to keep item in cache.