api

type CacheConfigInjector interface {
	CacheSystem() DeployableCache
}

type CacheSystem interface {
	FileSystem
	DeployableCache

	Flush(system FileSystem) error
	Clear() error
}

type DeployableCache interface {
	//Deploy will deploy a cache based on the config and viper values - can use plugins
	Deploy() error
	//Undeploy will remove a prior deployment
	Undeploy() error
	//Check checks if the cache is deployable, e.g. if the plugin is running, all configs are set. Should not interact with the cloud provider, just locally check if everything is ready
	Check() error
	//FunctionInjector can be used by function deployment code to modify function deployments to use the underling cache system, warning needs to be implemented for each platform individually
	FunctionInjector() CacheConfigInjector
}

type FileInfo struct {
	Name string // file path
	Size int64  // file size in bytes
}

type FileSystem interface {
	ListFiles(pathGlob string) ([]FileInfo, error)
	Stat(filePath string) (FileInfo, error)
	OpenReader(filePath string, startAt int64) (io.ReadCloser, error)
	OpenWriter(filePath string) (io.WriteCloser, error)
	Delete(filePath string) error
	Join(elem ...string) string
	Split(path string) []string
	Init() error
}

type Metrics struct {
	Fields map[string]string
	// contains filtered or unexported fields
}

type Plugin struct {
	FullName       string `json:"name"`       // FullName of the plugin, must be a go `get`-able package
	ExecutableName string `json:"executable"` // Name of the executable installed by go install
	// contains filtered or unexported fields
}