program

Documentation

Index

• Variables
• type Program
  • func (p Program) Args() []string
  • func (p Program) Bin() string
  • func (p Program) Run(ctx context.Context, stdout, stderr io.Writer) error
  • func (p Program) String() string
• type Template
  • func NewTemplate(args []string, logger log.Logger) (*Template, error)
  • func (t *Template) Execute(vars map[string]interface{}) (Program, error)
  • func (t *Template) String() string

Variables

var ErrNoProgramGiven = fmt.Errorf("no program given")

Types

type Program

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

Program represents a program that can be Run.

func (Program) Args

func (p Program) Args() []string

func (Program) Bin

func (p Program) Bin() string

func (Program) Run

func (p Program) Run(ctx context.Context, stdout, stderr io.Writer) error

Run runs the program, sending its STDOUT and STDERR to the given writers, and kills it if the context is done before the program has finished.

func (Program) String

func (p Program) String() string

type Template

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

Template represents a program, as a list of strings with at least the program's path as the first argument, plus any arguments. The program's path and arguments can be text templates.

func NewTemplate

func NewTemplate(args []string, logger log.Logger) (*Template, error)

func (*Template) Execute

func (t *Template) Execute(vars map[string]interface{}) (Program, error)

Execute executes each of the template args with the given vars, and return a Program.

func (*Template) String

func (t *Template) String() string