cli

Documentation

Index

• func ExitOnErrorWithMessage(exitcode exitcode.Enum, msg string) error
• func ExitOnInvalidArgument(msg string) error
• func ExitOnInvalidOption(msg string) error
• func ExitOnNotFound(msg string) error
• func ExitOnRPC(msg string) error
• func FailureResponse(err error) error
• func SuccessResponse(result interface{}) error
• func UserConfirmed(msg string) bool
• type PipeBridge
• type PipeBridgeController
  • func NewPipeBridgeController(bridges ...PipeBridge) (*PipeBridgeController, fail.Error)
  • func (pbc *PipeBridgeController) Start(ctx context.Context) fail.Error
  • func (pbc *PipeBridgeController) Stop() fail.Error
  • func (pbc *PipeBridgeController) Wait() fail.Error
• type Printer
• type StderrBridge
  • func NewStderrBridge(pipe io.ReadCloser) (*StderrBridge, fail.Error)
  • func (errp *StderrBridge) Print(data interface{})
  • func (cb StderrBridge) Reader() io.ReadCloser
• type StdoutBridge
  • func NewStdoutBridge(pipe io.ReadCloser) (*StdoutBridge, fail.Error)
  • func (outp *StdoutBridge) Print(data interface{})
  • func (cb StdoutBridge) Reader() io.ReadCloser

Functions

func ExitOnErrorWithMessage

func ExitOnErrorWithMessage(exitcode exitcode.Enum, msg string) error

ExitOnErrorWithMessage informs cli to exit with message and error code

func ExitOnInvalidArgument

func ExitOnInvalidArgument(msg string) error

ExitOnInvalidArgument ...

func ExitOnInvalidOption

func ExitOnInvalidOption(msg string) error

ExitOnInvalidOption ...

func ExitOnNotFound

func ExitOnNotFound(msg string) error

ExitOnNotFound ...

func ExitOnRPC

func ExitOnRPC(msg string) error

ExitOnRPC ...

func FailureResponse

func FailureResponse(err error) error

FailureResponse ...

func SuccessResponse

func SuccessResponse(result interface{}) error

SuccessResponse ...

func UserConfirmed

func UserConfirmed(msg string) bool

UserConfirmed asks user to confirm

Types

type PipeBridge

type PipeBridge interface {
	Printer
	Reader() io.ReadCloser
}

PipeBridge ...

type PipeBridgeController

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

PipeBridgeController is the controller of the bridges of pipe

func NewPipeBridgeController

func NewPipeBridgeController(bridges ...PipeBridge) (*PipeBridgeController, fail.Error)

NewPipeBridgeController creates a new controller of bridges of pipe

func (*PipeBridgeController) Start

func (pbc *PipeBridgeController) Start(ctx context.Context) fail.Error

Start initiates the capture of pipe outputs and the display of what is captured

func (*PipeBridgeController) Stop

func (pbc *PipeBridgeController) Stop() fail.Error

Stop the captures and the display.

func (*PipeBridgeController) Wait

func (pbc *PipeBridgeController) Wait() fail.Error

Wait waits the end of the goroutines

type Printer

type Printer interface {
	Print(interface{})
}

Printer ...

type StderrBridge

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

StderrBridge is a OutputPipe outputting on stderr

func NewStderrBridge

func NewStderrBridge(pipe io.ReadCloser) (*StderrBridge, fail.Error)

NewStderrBridge creates a pipe displaying on stderr

func (*StderrBridge) Print

func (errp *StderrBridge) Print(data interface{})

Print outputs the string to stderr

func (StderrBridge) Reader

func (cb StderrBridge) Reader() io.ReadCloser

type StdoutBridge

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

StdoutBridge is a PipeBridge outputting on stdout

func NewStdoutBridge

func NewStdoutBridge(pipe io.ReadCloser) (*StdoutBridge, fail.Error)

NewStdoutBridge creates an PipeBridge from a bufio.ReadCloser

func (*StdoutBridge) Print

func (outp *StdoutBridge) Print(data interface{})

Print outputs the string to stdout

func (StdoutBridge) Reader

func (cb StdoutBridge) Reader() io.ReadCloser