files

Documentation

Index

• Variables
• func DeleteFile(filepath string) error
• func Exists(filepath string, isDir bool) (bool, error)
• func GetActiveOrgFile() string
• func GetActiveOrgsPath() string
• func GetBrevDirectory() string
• func GetCertFilePath() string
• func GetKubeCertFileName() string
• func GetNewBackupSSHConfigFileName() string
• func GetNewBackupSSHConfigFilePath() (*string, error)
• func GetOrCreateSSHConfigFile(fs afero.Fs) (afero.File, error)
• func GetOrgCacheFile() string
• func GetOrgCacheFilePath() string
• func GetSSHPrivateKeyFileName() string
• func GetSSHPrivateKeyFilePath() string
• func GetUserSSHConfigPath() (*string, error)
• func GetWorkspaceCacheFile() string
• func GetWorkspacesCacheFilePath() string
• func OverwriteJSON(filepath string, v interface{}) error
• func OverwriteString(filepath string, data string) error
• func ReadJSON(unsafeFilePathString string, v interface{}) error
• func ReadString(unsafeFilePathString string) (string, error)
• func WriteSSHPrivateKey(fs afero.Fs, data string) error

Variables

var AppFs = afero.NewOsFs()

Functions

func DeleteFile

func DeleteFile(filepath string) error

Delete a single file altogether.

func Exists

func Exists(filepath string, isDir bool) (bool, error)

func GetActiveOrgFile

func GetActiveOrgFile() string

func GetActiveOrgsPath

func GetActiveOrgsPath() string

func GetBrevDirectory

func GetBrevDirectory() string

func GetCertFilePath

func GetCertFilePath() string

func GetKubeCertFileName

func GetKubeCertFileName() string

func GetNewBackupSSHConfigFileName

func GetNewBackupSSHConfigFileName() string

func GetNewBackupSSHConfigFilePath

func GetNewBackupSSHConfigFilePath() (*string, error)

func GetOrCreateSSHConfigFile

func GetOrCreateSSHConfigFile(fs afero.Fs) (afero.File, error)

func GetOrgCacheFile

func GetOrgCacheFile() string

func GetOrgCacheFilePath

func GetOrgCacheFilePath() string

func GetSSHPrivateKeyFileName

func GetSSHPrivateKeyFileName() string

func GetSSHPrivateKeyFilePath

func GetSSHPrivateKeyFilePath() string

func GetUserSSHConfigPath

func GetUserSSHConfigPath() (*string, error)

func GetWorkspaceCacheFile

func GetWorkspaceCacheFile() string

func GetWorkspacesCacheFilePath

func GetWorkspacesCacheFilePath() string

func OverwriteJSON

func OverwriteJSON(filepath string, v interface{}) error

OverwriteJSON data in the target file with data from the given struct

Usage (unstructured):

  OverwriteJSON("tmp/a/b/c.json", map[string]string{
	    "hi": "there",
  })

Usage (struct):

var foo myStruct
OverwriteJSON("tmp/a/b/c.json", foo)

func OverwriteString

func OverwriteString(filepath string, data string) error

OverwriteString data in the target file with data from the given string

Usage

OverwriteString("tmp/a/b/c.txt", "hi there")

func ReadJSON

func ReadJSON(unsafeFilePathString string, v interface{}) error

ReadJSON reads data from a file into the given struct

Usage:

var foo myStruct
files.ReadJSON("tmp/a.json", &foo)

func ReadString

func ReadString(unsafeFilePathString string) (string, error)

func WriteSSHPrivateKey

func WriteSSHPrivateKey(fs afero.Fs, data string) error