bundle

type Bundle interface {
	// List of commands that should be executed
	// to insert the bundle's contents into
	// a shell environment
	SourceCommands() []string

	// List of commands that should be executed
	// to insert the bundle's contents into
	// a POSIX-standard environment
	PosixSourceCommands() []string

	// List of commands that should be executed
	// to insert the bundle's contents into
	// a shell-standard environment
	//
	// The root path in the source commands will be replaced with location.
	// This is useful if you mount the store in a container want to access them in the container's mounted location.
	SourceCommandsUsingLocation(location string) []string

	// List of commands that should be executed
	// to insert the bundle's contents into
	// a POSIX-standard environment
	//
	// The root path in the source commands will be replaced with location.
	// This is useful if you mount the store in a container want to access them in the container's mounted location.
	PosixSourceCommandsUsingLocation(location string) []string

	// Releases all resources that this bundle holds
	Release()
}

type Cache interface {

	// Put a key into the storeItems, with it's corresponding contents.
	// If a key already exists, we ignore the Put command, in order to prevent double work.
	// A reader is passed in, so that BundleCache can write the contents, and Extract to disk.
	// an extractor is passed in so that bundle can call the extractor to Extract
	//
	// By default, a Put will set the item to "protected"
	//
	// Returns:
	// result for GetPath for this item that is put.
	// error if there are Extract errors
	Put(key string, extractor Extractor) (string, error)

	// Load existing keys into memory from disk.
	// The initial key load into memory refcount is 0
	// Return:
	// error if key doesn't exist on disk
	Load(keys []string) error

	// Given a key, get the root path to the extracted files.
	// An empty string "" is returned if the key doesn't exist.
	GetPath(key string) string

	// Given a key, does it exist in the storeItems?
	Exists(key string) bool

	// Return the root path of the store
	RootPath() string

	// Get keys from in use (refcount > 0) storeItems
	GetInUseItemKeys() []string

	// Tell the store that we're done with this item
	Release(key string) error

	// Deletes storage space of items that are unreferenced
	Cleanup()
}

type Extractor interface {
	// Extract contents to extractLocation using fs to write to the local file system.
	Extract(extractLocation string, fs fs.FileSystem) error
}

type ProgressCallback func(percentDone float32, timeElapsed time.Duration)

type Provider struct {
	// contains filtered or unexported fields
}