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() (string, error)
  • func (e *Executor) CaptureAndTrim() (string, error)
  • func (e *Executor) Run() error
  • func (e *Executor) RunWithCode() (int, error)
  • func (e *Executor) SetCwd(cwd string) *Executor
  • func (e *Executor) SetEnv(env []string) *Executor
  • func (e *Executor) SetOutputPrefix(prefix string) *Executor

Types

type Executor

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

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() (string, error)

Capture executes the command and return the output and the exit code

func (*Executor) CaptureAndTrim

func (e *Executor) CaptureAndTrim() (string, error)

CaptureAndTrim calls Capture() and trim the blank lines

func (*Executor) Run

func (e *Executor) Run() error

Run executes the command. Return an error for non-zero exitcode.

func (*Executor) RunWithCode

func (e *Executor) RunWithCode() (int, error)

RunWithCode executes the command. Return the exit code and an error.

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) SetOutputPrefix

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

SetOutputPrefix sets a prefix for each line printed by the command