commands

Documentation

Index

• Constants
• Variables
• func Cleanup()
• func Debug(format string, args ...interface{})
• func Error(format string, args ...interface{})
• func Exit(format string, args ...interface{})
• func ExitWithError(err error)
• func FullError(err error)
• func LoggedError(err error, format string, args ...interface{})
• func Panic(err error, format string, args ...interface{})
• func PipeCommand(name string, args ...string) error
• func PipeMediaCommand(name string, args ...string) error
• func Print(format string, args ...interface{})
• func RegisterSubcommand(fn func() *cobra.Command)
• func Run()
• func TransferManifest() *transfer.Manifest
• type PruneProgress
• type PruneProgressChan
• type PruneProgressType

Constants

const (
	PruneProgressTypeLocal  = PruneProgressType(iota)
	PruneProgressTypeRetain = PruneProgressType(iota)
	PruneProgressTypeVerify = PruneProgressType(iota)
)

Variables

var (
	// API is a package-local instance of the API client for use within
	// various command implementations.
	API = api.NewClient(nil)

	Debugging    = false
	ErrorBuffer  = &bytes.Buffer{}
	ErrorWriter  = io.MultiWriter(os.Stderr, ErrorBuffer)
	OutputWriter = io.MultiWriter(os.Stdout, ErrorBuffer)
	ManPages     = make(map[string]string, 20)
)

Functions

func Cleanup

func Cleanup()

func Debug

func Debug(format string, args ...interface{})

Debug prints a formatted message if debugging is enabled. The formatted message also shows up in the panic log, if created.

func Error

func Error(format string, args ...interface{})

Error prints a formatted message to Stderr. It also gets printed to the panic log if one is created for this command.

func Exit

func Exit(format string, args ...interface{})

Exit prints a formatted message and exits.

func ExitWithError

func ExitWithError(err error)

ExitWithError either panics with a full stack trace for fatal errors, or simply prints the error message and exits immediately.

func FullError

func FullError(err error)

FullError prints either a full stack trace for fatal errors, or just the error message.

func LoggedError

func LoggedError(err error, format string, args ...interface{})

LoggedError prints a formatted message to Stderr and writes a stack trace for the error to a log file without exiting.

func Panic

func Panic(err error, format string, args ...interface{})

Panic prints a formatted message, and writes a stack trace for the error to a log file before exiting.

func PipeCommand

func PipeCommand(name string, args ...string) error

func PipeMediaCommand

func PipeMediaCommand(name string, args ...string) error

func Print

func Print(format string, args ...interface{})

Print prints a formatted message to Stdout. It also gets printed to the panic log if one is created for this command.

func RegisterSubcommand

func RegisterSubcommand(fn func() *cobra.Command)

func Run

func Run()

func TransferManifest

func TransferManifest() *transfer.Manifest

TransferManifest builds a transfer.Manifest from the commands package global cfg var.

Types

type PruneProgress

type PruneProgress struct {
	ProgressType PruneProgressType
	Count        int // Number of items done
}

Progress from a sub-task of prune

type PruneProgressChan

type PruneProgressChan chan PruneProgress

type PruneProgressType

type PruneProgressType int