exec

Documentation

Index

• Variables
• type Process
  • func (p Process) Run(ctx context.Context) error
  • func (p Process) String() string
• type Shell
  • func DefaultShell() Shell
  • func MustParseShell(input string) Shell
  • func ParseShell(input string) (Shell, error)
  • func (s Shell) String() string
  • func (s *Shell) UnmarshalText(bb []byte) error

Variables

var (
	ErrMissingShell      = errors.New("missing shell")
	ErrUnrecognizedShell = errors.New("unrecognized shell")
)

var ErrMissingInput = errors.New("missing input")

Types

type Process

type Process struct {
	Directory   string
	Environment []string

	Shell Shell

	Verbose bool

	Args []string
}

Process is a child process.

func (Process) Run

func (p Process) Run(ctx context.Context) error

Run executes the underlying function.

func (Process) String

func (p Process) String() string

type Shell

type Shell uint

Shell is the name of a shell program to use to execute a command in.

const (
	ShellUnknown Shell = iota
	ShellBash
	ShellCmd
	ShellPowerShell
	ShellPwsh
	ShellSh
	ShellZsh
)

func DefaultShell

func DefaultShell() Shell

DefaultShell returns the default shell, based on the platform.

func MustParseShell

func MustParseShell(input string) Shell

Parses an input string as a shell name but panics if it would fail.

func ParseShell

func ParseShell(input string) (Shell, error)

Parses an input string as a shell name.

NOTE: This is a best effort implementation. Please open an issue on GitHub if some values are missing: github.com/coffeebeats/gdbuild/issues/new?labels=bug&template=%F0%9F%90%9B-bug-report.md.

func (Shell) String

func (s Shell) String() string

String implements 'fmt.Stringer' for 'Shell'.

func (*Shell) UnmarshalText

func (s *Shell) UnmarshalText(bb []byte) error