cache

type Client struct {
	// GetAPI is any cache client that can get items from the cache.
	GetAPI IGet
	// SetAPI is any cache client that can set items
	SetAPI ISet
}

type ClientAPIs interface {
	// IGet is an interface for all cache clients that support Get operations.
	IGet
	// ISet is an interface for all cache clients that support Set operations.
	ISet
}

type Config struct {
	// CacheProvider is the type of cache to use. These are constants in the cache package.
	CacheProvider constants.CacheType
	// CustomConfiguration is a configuration for a custom cache client. This field is required only if CacheProvider is set to
	// CustomCacheType.
	CustomConfiguration *CustomConfig
	// RedisConfiguration is a configuration for a redis cache client. This field is required only if CacheProvider is set to
	// RedisCacheType.
	RedisConfiguration *RedisConfig
}

type CustomConfig struct {
	Client ClientAPIs
}

type IGet interface {
	Get(ctx context.Context, key string) ([]byte, error)
}

type ISet interface {
	Set(ctx context.Context, key string, val any, ttl time.Duration) error
}

type RedisConfig struct {
	// RedisServerType is a constant that defines which redis server type the user is using.
	RedisServerType constants.RedisType
	// SingularConfig is the configuration for a singular redis server. This is required only if RedisServerType
	// is set to SingularRedisType.
	SingularConfig *redis.Options
	// ClusterConfig is the configuration for a redis cluster. This is required only if RedisServerType
	// is set to ClusterRedisType.
	ClusterConfig *redis.ClusterOptions
}