executor

Documentation

Index

• type Executor
  • func New(program string, args ...string) *Executor
  • func NewShell(cmdline string) *Executor
  • func (e *Executor) AddOutputFilter(substring string) *Executor
  • func (e *Executor) Capture() *Result
  • func (e *Executor) CaptureAndTrim() *Result
  • func (e *Executor) Run() *Result
  • func (e *Executor) SetCwd(cwd string) *Executor
  • func (e *Executor) SetEnv(env []string) *Executor
  • func (e *Executor) SetEnvVar(name, value string) *Executor
  • func (e *Executor) SetOutputPrefix(prefix string) *Executor
• type Result

Types

type Executor

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

Executor prepares and run a command execution

func New

func New(program string, args ...string) *Executor

New returns an *Executor that will run the program with arguments

func NewShell

func NewShell(cmdline string) *Executor

NewShell returns an *Executor that will run the command line in a shell

func (*Executor) AddOutputFilter

func (e *Executor) AddOutputFilter(substring string) *Executor

AddOutputFilter adds a substring to the list used to suppress lines printed by the command

func (*Executor) Capture

func (e *Executor) Capture() *Result

Capture executes the command and return a Result

func (*Executor) CaptureAndTrim

func (e *Executor) CaptureAndTrim() *Result

CaptureAndTrim calls Capture() and trim the blank lines

func (*Executor) Run

func (e *Executor) Run() *Result

Run executes the command and returns a Result

func (*Executor) SetCwd

func (e *Executor) SetCwd(cwd string) *Executor

SetCwd changes the current working directory the command will be run in

func (*Executor) SetEnv

func (e *Executor) SetEnv(env []string) *Executor

SetEnv changes the environment variables that will be used to run the command

func (*Executor) SetEnvVar

func (e *Executor) SetEnvVar(name, value string) *Executor

SetEnvVar sets a single variable in the environment that will be used to run the command

func (*Executor) SetOutputPrefix

func (e *Executor) SetOutputPrefix(prefix string) *Executor

SetOutputPrefix sets a prefix for each line printed by the command

type Result

type Result struct {
	Code        int    // code returned by the process
	Error       error  // error about the process launch and exit
	LaunchError error  // error about the process launch
	Output      string // command output if captured, otherwise empty
}

Result represents the result of a command execution