cache

type Cache ¶

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

Cache represents a cache.

func New(opts ...Option) *Cache

func (c *Cache) Close()

func (c *Cache) ConfiguredKeyPrefix() string

func (c *Cache) ConfiguredType() Type

func (c *Cache) Connection() redis.Cmdable

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

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

type ConnectionPassword ¶

type ConnectionPassword string

ConnectionPassword 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 Instance ¶ added in v0.15.0

type Instance[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
}

Instance of a cache.

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

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

type InstanceCloser ¶ added in v0.15.0

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

InstanceCloser represents a cache instance close method.

type InstancePinger ¶ added in v0.15.0

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

InstancePinger represents a cache instance ping method.

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 KeyNotFoundError ¶ added in v0.15.0

type KeyNotFoundError struct {
	Key string
}

KeyNotFoundError is returned when a cache key is not found.

func (e KeyNotFoundError) Error() string

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 Logger ¶ added in v0.30.0

type Logger struct{ *zap.Logger }

Logger sets the logger for the cache backends. When provided, internal backend log messages are forwarded to it; the zap logger's own level configuration controls what is actually emitted.

type Option ¶ added in v0.15.0

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

Option for the cache instance.

type Serialize ¶ added in v0.30.0

type Serialize bool

Serialize controls whether values are JSON-serialized before storage in the memory cache. Serialization is enabled by default to guarantee that values backed by unsafe byte-to-string conversions (e.g. from fasthttp buffers) are safely copied before the underlying buffer is reused.

Set Serialize(false) only when using the memory cache explicitly with types that cannot be JSON-serialized (e.g. structs containing channels or functions). Has no effect on Redis-backed caches which always serialize.

type TTL ¶

type TTL[T any] time.Duration

TTL represents time to keep item in cache.

type Type ¶ added in v0.15.0

type Type string

Type of a cache.

const (
	// MemoryCache store data in memory.
	MemoryCache Type = "memory"
	// RedisCache store data in Redis database.
	RedisCache Type = "redis"
	// RedisClusterCache store data in Redis database cluster.
	RedisClusterCache Type = "redis-cluster"
	// RedisSentinelCache store data in Redis database with sentinel.
	RedisSentinelCache Type = "redis-sentinel"
)