io

Documentation

Index

• Variables
• func Close(closer io.Closer, err *error)
• func CreateRandomLenFile(maxLen int, filesDir string, prefix string) string
• func GetFileInfo(path string, followSymlink bool) (fileInfo os.FileInfo, err error)
• func IsDirExists(path string, followSymlink bool) (bool, error)
• func IsFileSymlink(file os.FileInfo) bool
• func IsPathSymlink(path string) bool
• func RunCmd(config CmdConfig) error
• func RunCmdOutput(config CmdConfig) (string, error)
• func RunCmdWithOutputParser(config CmdConfig, prompt bool, regExpStruct ...*CmdOutputPattern) (stdOut string, errorOut string, exitOk bool, err error)
• func Walk(root string, walkFn WalkFunc, walkIntoDirSymlink bool) error
• type CmdConfig
• type CmdOutputPattern
• type Command
  • func NewCommand(executable, cmdName string, cmdArgs []string) *Command
  • func (config *Command) GetCmd() (cmd *exec.Cmd)
  • func (config *Command) GetEnv() map[string]string
  • func (config *Command) GetErrWriter() io.WriteCloser
  • func (config *Command) GetStdWriter() io.WriteCloser
  • func (config *Command) RunWithOutput() (data []byte, err error)
• type RandFile
  • func CreateRandFile(path string, len int) (file *RandFile, err error)
• type Stat
• type WalkFunc

Variables

var ErrSkipDir = errors.New("skip this directory")

Functions

func Close

func Close(closer io.Closer, err *error)

Close the reader/writer and append the error to the given error.

func CreateRandomLenFile

func CreateRandomLenFile(maxLen int, filesDir string, prefix string) string

func GetFileInfo

func GetFileInfo(path string, followSymlink bool) (fileInfo os.FileInfo, err error)

Get the file info of the file in path. If path points at a symlink and `followSymlink == false`, return the file info of the symlink instead

func IsDirExists

func IsDirExists(path string, followSymlink bool) (bool, error)

Check if path points at a directory. If path points at a symlink and `followSymlink == false`, function will return `false` regardless of the symlink target

func IsFileSymlink

func IsFileSymlink(file os.FileInfo) bool

func IsPathSymlink

func IsPathSymlink(path string) bool

func RunCmd

func RunCmd(config CmdConfig) error

Runs an external process and prints its output to stdout / stderr.

func RunCmdOutput

func RunCmdOutput(config CmdConfig) (string, error)

Executes an external process and returns its output. If the returned output is not needed, use the RunCmd function instead , for better performance.

func RunCmdWithOutputParser

func RunCmdWithOutputParser(config CmdConfig, prompt bool, regExpStruct ...*CmdOutputPattern) (stdOut string, errorOut string, exitOk bool, err error)

Executes the command and captures the output. Analyze each line to match the provided regex. Returns the complete stdout output of the command.

func Walk

func Walk(root string, walkFn WalkFunc, walkIntoDirSymlink bool) error

The same as filepath.Walk the only difference is that we can walk into symlink. Avoiding infinite loops by saving the real paths we already visited.

Types

type CmdConfig

type CmdConfig interface {
	GetCmd() *exec.Cmd
	GetEnv() map[string]string
	GetStdWriter() io.WriteCloser
	GetErrWriter() io.WriteCloser
}

type CmdOutputPattern

type CmdOutputPattern struct {
	RegExp         *regexp.Regexp
	MatchedResults []string
	Line           string
	ExecFunc       func(pattern *CmdOutputPattern) (string, error)
}

RegExp - The regexp that the line will be searched upon. MatchedResults - The slice result that was found by the regexp Line - The output line from the external process ExecFunc - The function to execute

type Command

type Command struct {
	Executable string
	CmdName    string
	CmdArgs    []string
	Dir        string
	StrWriter  io.WriteCloser
	ErrWriter  io.WriteCloser
}

func NewCommand

func NewCommand(executable, cmdName string, cmdArgs []string) *Command

func (*Command) GetCmd

func (config *Command) GetCmd() (cmd *exec.Cmd)

func (*Command) GetEnv

func (config *Command) GetEnv() map[string]string

func (*Command) GetErrWriter

func (config *Command) GetErrWriter() io.WriteCloser

func (*Command) GetStdWriter

func (config *Command) GetStdWriter() io.WriteCloser

func (*Command) RunWithOutput

func (config *Command) RunWithOutput() (data []byte, err error)

type RandFile

type RandFile struct {
	*os.File
	Info os.FileInfo
}

func CreateRandFile

func CreateRandFile(path string, len int) (file *RandFile, err error)

type Stat

type Stat func(path string) (info os.FileInfo, err error)

type WalkFunc

type WalkFunc func(path string, info os.FileInfo, err error) error