iostreams

Documentation

Index

• type IOStreams
  • func System() *IOStreams
  • func (s *IOStreams) IsStderrTTY() bool
  • func (s *IOStreams) IsStdinTTY() bool
  • func (s *IOStreams) IsStdoutTTY() bool
  • func (s *IOStreams) SetStderrTTY(isTTY bool)
  • func (s *IOStreams) SetStdinTTY(isTTY bool)
  • func (s *IOStreams) SetStdoutTTY(isTTY bool)
  • func (s *IOStreams) StartProgressIndicator(str string)
  • func (s *IOStreams) StopProgressIndicator()

Types

type IOStreams

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

IOStreams contains information for input/output used in the CLI.

func System

func System() *IOStreams

System returns an IOStreams object with prepared input/output.

func (*IOStreams) IsStderrTTY

func (s *IOStreams) IsStderrTTY() bool

IsStderrTTY checks if stderr is a TTY.

func (*IOStreams) IsStdinTTY

func (s *IOStreams) IsStdinTTY() bool

IsStdinTTY checks if stdin is a TTY.

func (*IOStreams) IsStdoutTTY

func (s *IOStreams) IsStdoutTTY() bool

IsStdoutTTY checks if stdout is a TTY.

func (*IOStreams) SetStderrTTY

func (s *IOStreams) SetStderrTTY(isTTY bool)

SetStderrTTY marks stderr as TTY.

func (*IOStreams) SetStdinTTY

func (s *IOStreams) SetStdinTTY(isTTY bool)

SetStdinTTY marks stdin as TTY.

func (*IOStreams) SetStdoutTTY

func (s *IOStreams) SetStdoutTTY(isTTY bool)

SetStdoutTTY marks stdout as TTY.

func (*IOStreams) StartProgressIndicator

func (s *IOStreams) StartProgressIndicator(str string)

StartProgressIndicator creates a new spinner indicator.

func (*IOStreams) StopProgressIndicator

func (s *IOStreams) StopProgressIndicator()

StopProgressIndicator stops the running spinner indicator.