cmdutil

Documentation

Index

• Variables
• func FlagErrorWrap(err error) error
• func FlagErrorf(format string, args ...interface{}) error
• func IsUserCancellation(err error) bool
• func MutuallyExclusive(message string, conditions ...bool) error
• func StringEnumFlag(cmd *cobra.Command, p *string, name, shorthand, defaultValue string, ...) *pflag.Flag
• type Factory
  • func NewFactory() *Factory
  • func (f *Factory) Executable() string
• type FlagError
  • func (fe *FlagError) Error() string
  • func (fe *FlagError) Unwrap() error
• type NoResultsError
  • func NewNoResultsError(message string) NoResultsError
  • func (e NoResultsError) Error() string

Variables

var CancelError = errors.New("CancelError")

CancelError signals user-initiated cancellation

var SilentError = errors.New("SilentError")

SilentError is an error that triggers exit code 1 without any error messaging

Functions

func FlagErrorWrap

func FlagErrorWrap(err error) error

FlagError returns a new FlagError that wraps the specified error.

func FlagErrorf

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

FlagErrorf returns a new FlagError that wraps an error produced by fmt.Errorf(format, args...).

func IsUserCancellation

func IsUserCancellation(err error) bool

func MutuallyExclusive

func MutuallyExclusive(message string, conditions ...bool) error

func StringEnumFlag

func StringEnumFlag(cmd *cobra.Command, p *string, name, shorthand, defaultValue string, options []string, usage string) *pflag.Flag

StringEnumFlag defines a new string flag that only allows values listed in options.

Types

type Factory

type Factory struct {
	IOStreams      *iostreams.IOStreams
	ExecutableName string
}

func NewFactory

func NewFactory() *Factory

func (*Factory) Executable

func (f *Factory) Executable() string

Executable is the path to the currently invoked binary

type FlagError

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

A *FlagError indicates an error processing command-line flags or other arguments. Such errors cause the application to display the usage message.

func (*FlagError) Error

func (fe *FlagError) Error() string

func (*FlagError) Unwrap

func (fe *FlagError) Unwrap() error

type NoResultsError

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

func NewNoResultsError

func NewNoResultsError(message string) NoResultsError

func (NoResultsError) Error

func (e NoResultsError) Error() string