cache

type Cache interface {
	// Get 获取缓存项
	//
	// 当前不存在时，返回 [ErrCacheMiss] 错误。
	// key 为缓存项的唯一 ID；
	// v 为缓存写入的地址，应该始终为指针类型；
	//
	// NOTE: 不能正确获取由 [Cache.Counter] 设置的值，[Cache.Counter]
	// 的实现是基于缓存系统原生的功能，存储方式与当前的实现可能是不同的。
	Get(key string, v any) error

	// Set 设置或是添加缓存项
	//
	// key 表示保存该数据的唯一 ID；
	// val 表示保存的数据对象，如果是结构体，需要所有的字段都是公开的或是实现了
	// [Marshaler] 和 [Unmarshaler] 接口，否则在 [Cache.Get] 中将失去这些非公开的字段。
	// ttl 表示过了该时间，缓存项将被回收。如果该值为 0，该值永远不会回收。
	Set(key string, val any, ttl int) error

	// Delete 删除一个缓存项
	Delete(string) error

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

	// Counter 返回计数器操作接口
	//
	// val 和 ttl 表示在该计数器不存在时，初始化的值以及回收时间。
	Counter(key string, val uint64, ttl int) Counter
}

type CleanableCache interface {
	Cache

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

type Counter interface {
	// Incr 增加计数并返回增加后的值
	Incr(uint64) (uint64, error)

	// Decr 减少数值并返回减少后的值
	Decr(uint64) (uint64, error)

	// Value 返回该计数器的当前值
	//
	// 如果出错将返回默认值。
	Value() (uint64, error)
}

type Driver interface {
	CleanableCache

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

type Serializer interface {
	// MarshalCache 将对象转换成 []byte
	MarshalCache() ([]byte, error)

	// UnmarshalCache 从 []byte 中恢复数据
	UnmarshalCache([]byte) error
}