Interface Path

util/pkg/vfs/vfs.go:45–78

Path is a path in the VFS space, which we can read, write, list etc

// Path is a path in the VFS space, which we can read, write, list etc
type Path interface {
	io.WriterTo
	Join(relativePath ...string) Path

	// ReadFile returns the contents of the file, or an error if the file could not be read.
	// If the file did not exist, err = os.ErrNotExist
	// As this reads the entire file into memory, consider using WriteTo for bigger files
	ReadFile(ctx context.Context) ([]byte, error)
	WriteFile(ctx context.Context, data io.ReadSeeker, acl ACL) error
	// CreateFile writes the file contents, but only if the file does not already exist
	CreateFile(ctx context.Context, data io.ReadSeeker, acl ACL) error

	// Remove deletes the file
	Remove(ctx context.Context) error

	// RemoveAll deletes all files recursively, deletes only files as returned per ReadTree
	RemoveAll(ctx context.Context) error

	// RemoveAllVersions completely deletes the file (with all its versions and markers).
	RemoveAllVersions(ctx context.Context) error

	// Base returns the base name (last element)
	Base() string

	// Path returns a string representing the full path
	Path() string

	// ReadDir lists the files in a particular Path
	ReadDir() ([]Path, error)

	// ReadTree lists all files (recursively) in the subtree rooted at the current Path
	/// Note: returns only files, not directories
	ReadTree(ctx context.Context) ([]Path, error)
}

// TerraformPath is a Path that can render to Terraform.
type TerraformPath interface {