path

Documentation

Overview

Package path contains functions to find/calculate path used in the project.

Index

• type Finch
  • func FindFinch(deps FinchFinderDeps) (Finch, error)
  • func (w Finch) BaseYamlFilePath() string
  • func (Finch) ConfigFilePath(rootDir string) string
  • func (Finch) FinchDir(rootDir string) string
  • func (Finch) FinchRootDir(ffd FinchFinderDeps) (string, error)
  • func (w Finch) LimaConfigDirectoryPath() string
  • func (w Finch) LimaDefaultConfigPath() string
  • func (w Finch) LimaHomePath() string
  • func (w Finch) LimaInstancePath() string
  • func (w Finch) LimaOverrideConfigPath() string
  • func (w Finch) LimaSSHPrivateKeyPath() string
  • func (w Finch) LimactlPath() string
  • func (w Finch) QEMUBinDir() string
  • func (w Finch) UserDataDiskPath(rootDir string) string
• type FinchFinderDeps

Types

type Finch

type Finch string

Finch provides a set of methods that calculate paths relative to the Finch path.

func FindFinch

func FindFinch(deps FinchFinderDeps) (Finch, error)

FindFinch finds the installation path of Finch.

func (Finch) BaseYamlFilePath

func (w Finch) BaseYamlFilePath() string

BaseYamlFilePath returns the base yaml file path.

func (Finch) ConfigFilePath

func (Finch) ConfigFilePath(rootDir string) string

ConfigFilePath returns the path to Finch config file.

func (Finch) FinchDir

func (Finch) FinchDir(rootDir string) string

FinchDir returns the path to the Finch config directory.

func (Finch) FinchRootDir

func (Finch) FinchRootDir(ffd FinchFinderDeps) (string, error)

FinchRootDir returns the path to the Finch root directory, which is $HOME on UNIX.

func (Finch) LimaConfigDirectoryPath

func (w Finch) LimaConfigDirectoryPath() string

LimaConfigDirectoryPath returns the lima config directory path.

func (Finch) LimaDefaultConfigPath

func (w Finch) LimaDefaultConfigPath() string

LimaDefaultConfigPath returns the lima override config file path.

func (Finch) LimaHomePath

func (w Finch) LimaHomePath() string

LimaHomePath returns the path that should be set to LIMA_HOME for Finch.

func (Finch) LimaInstancePath

func (w Finch) LimaInstancePath() string

LimaInstancePath returns the path to the Lima instance of the Finch VM.

func (Finch) LimaOverrideConfigPath

func (w Finch) LimaOverrideConfigPath() string

LimaOverrideConfigPath returns the lima override config file path.

func (Finch) LimaSSHPrivateKeyPath

func (w Finch) LimaSSHPrivateKeyPath() string

LimaSSHPrivateKeyPath returns the lima user key path.

func (Finch) LimactlPath

func (w Finch) LimactlPath() string

LimactlPath returns the limactl path.

func (Finch) QEMUBinDir

func (w Finch) QEMUBinDir() string

QEMUBinDir returns the path to the directory that contains all the binaries QEMU depends on. It's used to enable users to always use the pinned versions of the binaries.

func (Finch) UserDataDiskPath

func (w Finch) UserDataDiskPath(rootDir string) string

UserDataDiskPath returns the path to the permanent storage location of the Finch user data disk.

type FinchFinderDeps

type FinchFinderDeps interface {
	system.SymlinksEvaluator
	system.ExecutableFinder
	system.FilePathJoiner
	system.EnvGetter
	system.UserHomeDir
}

FinchFinderDeps provides all the dependencies FindFinch needs to find Finch.