cache

type Cache interface {
	// Get gets the value from cache and unmarshal it to v. Make sure the value is a pointer and zero.
	Get(ctx context.Context, key string, value any, opts ...Option) error
	// Set sets the value to cache.
	Set(ctx context.Context, key string, value any, opts ...Option) error
	// Has reports whether the value for the given key exists.
	Has(ctx context.Context, key string) bool
	// Del deletes the value for the given key.
	Del(ctx context.Context, key string) error
	// IsNotFound detect the error weather not found from cache
	IsNotFound(err error) bool
}

type MarshalFunc func(any) ([]byte, error)

type Option func(*Options)

type Options struct {
	// TTL is the cache expiration time.
	TTL time.Duration
	// Getter returns value to be cached.call getter to get a value(such as query database) and set cache using c.expiry
	Getter func(ctx context.Context, key string) (any, error)
	// SetXX only sets the key if it already exists.
	SetXX bool
	// SetNX only sets the key if it does not already exist.
	SetNX bool
	// SkipFlags indicator skip level.
	Skip SkipMode
	// Raw indicates whether to skip serialization. default is false to keep coroutine safe.
	// Caches accessed across processes are serialized, that flag Generally used for memory cache.
	//
	// false that means serialize value to Item.V. if true, Item.V is raw value but support by implemented Cache.
	// has implemented Cache: lfu cache
	Raw bool
	// Group indicates whether to singleflight.
	Group bool
}

type SkipMode int

type Stats struct {
	Hits   uint64
	Misses uint64
}

type UnmarshalFunc func([]byte, any) error