cache

type Cache interface {
	// String returns the name of the implementation.
	String() string

	// Get gets a cached value by key.
	Get(ctx context.Context, key string) (any, time.Time, error)
	// Put stores a key-value pair into cache.
	Put(ctx context.Context, key string, val any, d time.Duration) error
	// Delete removes a key from cache.
	Delete(ctx context.Context, key string) error

	// MultiGet gets multiple cached values by key.
	MultiGet(ctx context.Context, keys []string) (map[string]any, error)
	// MultiPut stores multiple key-value pairs into cache.
	MultiPut(ctx context.Context, items map[string]Item, d time.Duration) error
	// MultiDelete removes multiple keys from cache.
	MultiDelete(ctx context.Context, keys []string) error

	// Incr increments a key by delta.
	Incr(ctx context.Context, key string, delta int64) (int64, error)
	// Decr decrements a key by delta.
	Decr(ctx context.Context, key string, delta int64) (int64, error)
	// CompareAndSwap compares the old value with the value stored in the cache.
	// If they match, the new value is stored in the cache and true is returned.
	// If they don't match, the old value is returned and false is returned.
	CompareAndSwap(ctx context.Context, key string, old, new any) (bool, error)

	// Lock attempts to acquire a lock with the provided key and ttl.
	Lock(ctx context.Context, key string, ttl time.Duration) (bool, error)
	// Unlock releases the lock with the provided key.
	Unlock(ctx context.Context, key string) (bool, error)
	// Renew attempts to renew the lock with the provided key and ttl.
	Renew(ctx context.Context, key string, ttl time.Duration) (bool, error)
}

type Item struct {
	Value      any
	Expiration int64
}

type Option func(o *Options)

type Options struct {
	// Context should contain all implementation specific options, using context.WithValue.
	Context context.Context
	// Logger is the be used logger
	Logger logger.Logger
	Items  map[string]Item
	// Address represents the address or other connection information of the cache service.
	Address    string
	Expiration time.Duration
}