process

Documentation

Overview

Package process runs external commands while preserving structured failure information and allowing output to be captured, streamed, or both.

Index

• type Failure
  • func (e *Failure) Error() string
  • func (e *Failure) SensitiveArgs() bool
  • func (e *Failure) Unwrap() error
• type Output
  • func Run(ctx context.Context, spec Spec) (Output, error)
• type Spec

Types

type Failure

type Failure struct {
	Path   string
	Args   []string
	Code   int
	Stderr string
	Cause  error
}

func (*Failure) Error

func (e *Failure) Error() string

func (*Failure) SensitiveArgs

func (e *Failure) SensitiveArgs() bool

func (*Failure) Unwrap

func (e *Failure) Unwrap() error

type Output

type Output struct {
	Stdout []byte
	Stderr []byte
}

func Run

func Run(ctx context.Context, spec Spec) (Output, error)

type Spec

type Spec struct {
	Path      string
	Args      []string
	Dir       string
	Env       []string
	Stdin     io.Reader
	Stdout    io.Writer
	Stderr    io.Writer
	Sensitive bool
	// Clean runs the process with exactly Env as its environment, without
	// inheriting the parent's (a tighter effect capability). When false, a
	// non-nil Env is appended to the inherited environment.
	Clean bool
}