process

Documentation

Overview

Package process executes a binary

Index

• type Binary
• type Option
• type Options
• type PID
• type Package
• type Process
• type Source

Types

type Binary

type Binary struct {
	// Package containing executable
	Package *Package
	// The env variables
	Env []string
	// Args to pass
	Args []string
	// Initial working directory
	Dir string
}

type Option

type Option func(o *Options)

type Options

type Options struct{}

type PID

type PID struct {
	// ID of the process
	ID string
	// Stdin
	Input io.Writer
	// Stdout
	Output io.Reader
	// Stderr
	Error io.Reader
}

PID is the running process

type Package

type Package struct {
	// Name of the package
	Name string
	// Location of the package
	Path string
	// Type of package e.g tarball, binary, docker
	Type string
	// Source of the package
	Source *Source
}

Package is packaged format for source

type Process

type Process interface {
	// Executes a process to completion
	Exec(*Binary) error
	// Creates a new process
	Fork(*Binary) (*PID, error)
	// Kills the process
	Kill(*PID) error
	// Waits for a process to exit
	Wait(*PID) error
}

Process manages a running process

type Source

type Source struct {
	// Path to the source if local
	Path string
	// Language is the language of code
	Language string
	// Location of the source
	Repository string
}

Source is the source of a build