cachex

Jun 28, 2026

Changes in this version

+ const CodeLockNotAcquired

+ const CodeLockNotHeld

+ var ErrLockNotAcquired = errors.New("cachex: lock not acquired")

+ var ErrLockNotHeld = errors.New("cachex: lock not held")

type Cache

+ Lock func(ctx context.Context, key string, ttl time.Duration) (token string, err error)

+ Unlock func(ctx context.Context, key, token string) error

Jun 28, 2026

Changes in this version

+ const CodeClosed

+ const CodeInvalidConfig

+ const CodeNilValue

+ const CodeNotFound

+ const CodeOperationFailed

+ const CodeTimeout

+ const CodeTypeMismatch

+ const CodeUnknownDriver

+ func NormalizeError(err error) error

type Config

+ Logger logx.Logger

+ Metrics metricsx.Manager

+ MetricsEnabled bool

Jun 28, 2026

Changes in this version

+ var ErrClosed = errors.New("cachex: cache is closed")

+ var ErrNilConfig = errors.New("cachex: config is missing required fields")

+ var ErrNilValue = errors.New("cachex: value function returned nil")

+ var ErrNotFound = errors.New("cachex: key not found")

+ var ErrTypeMismatch = errors.New("cachex: type mismatch during deserialization")

+ var ErrUnknownDriver = errors.New("cachex: unknown driver (did you import cachex/redis?)")

+ func IsDriverRegistered(name string) bool

+ func RegisterDriver(name string, fn DriverOpener)

+ func RegisteredDrivers() []string

+ type Cache interface

+ Close func() error

+ Decr func(ctx context.Context, key string) (int64, error)

+ Del func(ctx context.Context, keys ...string) error

+ DriverName func() string

+ Exists func(ctx context.Context, keys ...string) (int64, error)

+ Expire func(ctx context.Context, key string, ttl time.Duration) error

+ Get func(ctx context.Context, key string, dest any) error

+ GetOrSet func(ctx context.Context, key string, dest any, ttl time.Duration, ...) error

+ HDel func(ctx context.Context, key string, fields ...string) error

+ HGet func(ctx context.Context, key, field string, dest any) error

+ HGetAll func(ctx context.Context, key string, dest any) error

+ HSet func(ctx context.Context, key, field string, value any) error

+ Incr func(ctx context.Context, key string) (int64, error)

+ IncrBy func(ctx context.Context, key string, delta int64) (int64, error)

+ LLen func(ctx context.Context, key string) (int64, error)

+ LPop func(ctx context.Context, key string, dest any) error

+ LPush func(ctx context.Context, key string, values ...any) error

+ LRange func(ctx context.Context, key string, start, stop int64, dest any) error

+ MGet func(ctx context.Context, keys []string, dest any) error

+ MSet func(ctx context.Context, pairs map[string]any, ttl time.Duration) error

+ Ping func(ctx context.Context) error

+ Publish func(ctx context.Context, channel string, message any) (int64, error)

+ RPop func(ctx context.Context, key string, dest any) error

+ RPush func(ctx context.Context, key string, values ...any) error

+ SAdd func(ctx context.Context, key string, members ...any) error

+ SIsMember func(ctx context.Context, key string, member any) (bool, error)

+ SMembers func(ctx context.Context, key string, dest any) error

+ SRem func(ctx context.Context, key string, members ...any) error

+ Set func(ctx context.Context, key string, value any, ttl time.Duration) error

+ SetIfNotExist func(ctx context.Context, key string, value any, ttl time.Duration) (bool, error)

+ Subscribe func(ctx context.Context, channels ...string) (*Subscription, error)

+ TTL func(ctx context.Context, key string) (time.Duration, error)

+ func New(cfg Config) (Cache, error)

+ type Config struct

+ Addrs []string

+ Cluster bool

+ DB int

+ DialTimeout time.Duration

+ Driver string

+ KeyPrefix string

+ MasterName string

+ MinIdleConns int

+ Password string

+ PoolSize int

+ ReadTimeout time.Duration

+ TLSEnabled bool

+ TLSSkipVerify bool

+ Username string

+ WriteTimeout time.Duration

+ func (c Config) Validate() error

+ type DriverOpener func(cfg Config) (Cache, error)

+ type Message struct

+ Channel string

+ Pattern string

+ Payload string

+ type Subscription struct

+ Channel <-chan *Message

+ CloseFn func() error

+ UnsubscribeFn func(channels ...string) error

+ func (s *Subscription) Close() error

+ func (s *Subscription) Unsubscribe(channels ...string) error