cache

type Cache interface {
	// Get 获取缓存项
	//
	// 当前不存在时，返回 [ErrCacheMiss] 错误。
	// key 为缓存项的唯一 ID；
	// v 为缓存写入的地址，应该始终为指针类型；
	Get(key string, v any) error

	// Set 设置或是添加缓存项
	//
	// key 表示保存该数据的唯一 ID；
	// val 表示保存的数据对象，如果是结构体，则会调用 gob 包进行序列化。
	// ttl 表示过了该时间，缓存项将被回收。如果该值为 [Forever]，该值永远不会回收。
	Set(key string, val any, ttl time.Duration) error

	// Delete 删除一个缓存项
	//
	// 如果该项目不存在，则返回 nil。
	Delete(string) error

	// Exists 判断一个缓存项是否存在
	Exists(string) bool

	// Touch 重新设置缓存项的过期时间
	//
	// 如果不存在该项，不会返回 [ErrCacheMiss]，而是 nil。
	Touch(key string, ttl time.Duration) error

	// Counter 从 key 指向的值初始化一个计数器操作接口
	//
	// key 表示计数器在缓存中的名称，如果已经存在同名值，将采用该值，否则初始化为零。
	// 如果 key 指定的值无法被当作数值操作，将在 f 的调用中返回相应在的错误。
	//
	// n 表示当前的数值；
	// f 表示对数据进行操作的函数；
	// exist 表示该元素原来是否就存在；
	Counter(key string, ttl time.Duration) (n uint64, f SetCounterFunc, exist bool, err error)
}

type Cleanable interface {
	Cache

	// Clean 清除所有的缓存内容
	Clean() error
}

type Driver interface {
	Cleanable

	// Ping 检测连接是否依然有效
	Ping() error

	// Close 关闭客户端
	Close() error

	// Driver 关联的底层驱动实例
	Driver() any
}

type SetCounterFunc = func(n int) (uint64, error)