cache

type Cache interface {
	Exists(key string) (bool, error)
	ExistsCtx(ctx context.Context, key string) (bool, error)
	Hexists(key string, field string) (bool, error)
	HexistsCtx(ctx context.Context, key string, field string) (bool, error)
	// Del deletes cached values with keys.
	Del(keys ...string) error
	// DelCtx deletes cached values with keys.
	DelCtx(ctx context.Context, keys ...string) error
	// Delx deletes cached values with key and fields.
	Delx(key string, fields ...string) error
	// DelxCtx deletes cached values with key and fields.
	DelxCtx(ctx context.Context, key string, fields ...string) error
	// Get gets the cache with key and fills into v.
	Get(key string, val any) error
	// GetCtx gets the cache with key and fills into v.
	GetCtx(ctx context.Context, key string, val any) error
	// IsNotFound checks if the given error is the defined errNotFound.
	IsNotFound(err error) bool
	// Set sets the cache with key and v, using c.expiry.
	Set(key string, val any) error
	// SetCtx sets the cache with key and v, using c.expiry.
	SetCtx(ctx context.Context, key string, val any) error
	// Set sets the cache with key and v, using c.expiry.
	HSet(key string, fields string, val any) error
	// SetCtx sets the cache with key and v, using c.expiry.
	HsetCtx(ctx context.Context, key string, fields string, val any) error
	// Get gets the cache with key and fills into v.
	HGet(key string, fields string, val any) error
	// GetCtx gets the cache with key and fills into v.
	HGetCtx(ctx context.Context, key string, fields string, val any) error
	// SetWithExpire sets the cache with key and v, using given expire.
	SetWithExpire(key string, val any, expire time.Duration) error
	// SetWithExpireCtx sets the cache with key and v, using given expire.
	SetWithExpireCtx(ctx context.Context, key string, val any, expire time.Duration) error
	// Take takes the result from cache first, if not found,
	// query from DB and set cache using c.expiry, then return the result.
	Take(val any, key string, query func(val any) error) error
	// Takex takes the result from cache first, key and field, if not found,
	// query from DB and set cache using c.expiry, then return the result.
	Takex(val any, key, field string, query func(val any) error) error
	// TakeCtx takes the result from cache first, if not found,
	// query from DB and set cache using c.expiry, then return the result.
	TakeCtx(ctx context.Context, val any, key string, query func(val any) error) error
	// TakexCtx takes the result from cache first, key and field, if not found,
	// query from DB and set cache using c.expiry, then return the result.
	TakexCtx(ctx context.Context, val any, key, field string, query func(val any) error) error
	// TakeWithExpire takes the result from cache first, if not found,
	// query from DB and set cache using given expire, then return the result.
	TakeWithExpire(val any, key string, query func(val any, expire time.Duration) error) error
	// TakeWithExpireCtx takes the result from cache first, if not found,
	// query from DB and set cache using given expire, then return the result.
	TakeWithExpireCtx(ctx context.Context, val any, key string,
		query func(val any, expire time.Duration) error) error
	// TakeWithExpire2 takes the result from cache first, if not found,
	// query from DB and set cache using given expire, then return the result.
	TakeWithExpire2(val any, key string, field string, query func(val any) error) error
	// TakeWithExpire2Ctx takes the result from cache first, if not found,
	// query from DB and set cache using given expire, then return the result.
	TakeWithExpire2Ctx(ctx context.Context, val any, key string, field string, query func(val any) error) error
	// TakeAllOne takes the result from cache first, key and fields, if not found,
	// query from DB and set cache using c.expiry, then return the result.
	TakeAllOne(val any, key string, query func(val any, leftFields ...string) error) error

	// TakeAllOneCtx takes the result from cache first by key and struct tag fields, if not found,
	// query from DB and set cache using c.expiry, then return the result.
	TakeAllOneCtx(ctx context.Context, val any, key string,
		query func(val any, leftFields ...string) error) error

	// Expire is the implementation of redis expire command.
	Expire(key string, expire time.Duration) error
	// ExpireCtx is the implementation of redis expire command.
	ExpireCtx(ctx context.Context, key string, expire time.Duration) error
}

type CacheConf = ClusterConf

type ClusterConf []NodeConf

type NodeConf struct {
	redis.RedisConf
	Weight int `json:",default=100"`
}

type Option func(o *Options)

type Options struct {
	Expiry         time.Duration
	NotFoundExpiry time.Duration
}

type Stat struct {

	// export the fields to let the unit tests working,
	// reside in internal package, doesn't matter.
	Total   uint64
	Hit     uint64
	Miss    uint64
	DbFails uint64
	// contains filtered or unexported fields
}