iostreams

Documentation

Index

• type IOStreams
  • func System() *IOStreams
  • func (s *IOStreams) CanPrompt() bool
  • func (s *IOStreams) IsSSHSession() bool
  • func (s *IOStreams) IsStderrTTY() bool
  • func (s *IOStreams) IsStdinTTY() bool
  • func (s *IOStreams) IsStdoutTTY() bool
  • func (s *IOStreams) NewSpinner() *spinner.Spinner
  • func (s *IOStreams) SetStderrTTY(isTTY bool)
  • func (s *IOStreams) SetStdinTTY(isTTY bool)
  • func (s *IOStreams) SetStdoutTTY(isTTY bool)

Types

type IOStreams

type IOStreams struct {
	In     io.ReadCloser
	Out    io.Writer
	ErrOut io.Writer
	// contains filtered or unexported fields
}

IOStreams is a type which defines the streams for the program

func System

func System() *IOStreams

System creates an IOStreams using the standard system streams

func (*IOStreams) CanPrompt

func (s *IOStreams) CanPrompt() bool

CanPrompt detects if the input is a TTY

func (*IOStreams) IsSSHSession

func (s *IOStreams) IsSSHSession() bool

func (*IOStreams) IsStderrTTY

func (s *IOStreams) IsStderrTTY() bool

func (*IOStreams) IsStdinTTY

func (s *IOStreams) IsStdinTTY() bool

func (*IOStreams) IsStdoutTTY

func (s *IOStreams) IsStdoutTTY() bool

func (*IOStreams) NewSpinner

func (s *IOStreams) NewSpinner() *spinner.Spinner

NewSpinner returns a new spinner progress bar to be used in synchronous commands

func (*IOStreams) SetStderrTTY

func (s *IOStreams) SetStderrTTY(isTTY bool)

func (*IOStreams) SetStdinTTY

func (s *IOStreams) SetStdinTTY(isTTY bool)

func (*IOStreams) SetStdoutTTY

func (s *IOStreams) SetStdoutTTY(isTTY bool)