Documentation
¶
Overview ¶
Package stream provides NullStream
Package stream defines input and output streams.
Index ¶
- Variables
- func IsNullWriter(writer io.Writer) bool
- type IOStream
- func (str IOStream) EPrint(args ...interface{}) (n int, err error)
- func (str IOStream) EPrintf(format string, args ...interface{}) (n int, err error)
- func (str IOStream) EPrintln(args ...interface{}) (n int, err error)
- func (str IOStream) NonInteractive() IOStream
- func (str IOStream) Print(args ...interface{}) (n int, err error)
- func (str IOStream) Printf(format string, args ...interface{}) (n int, err error)
- func (str IOStream) Println(args ...interface{}) (n int, err error)
- func (str IOStream) ReadLine() (string, error)
- func (str IOStream) ReadPassword() (string, error)
- func (str IOStream) ReadPasswordStrict() (string, error)
- func (str IOStream) StderrIsATerminal() bool
- func (str IOStream) StdinIsATerminal() bool
- func (str IOStream) StdoutIsATerminal() bool
- func (str IOStream) Streams(Stdout, Stderr io.Writer, Stdin io.Reader, wrap int) IOStream
Constants ¶
This section is empty.
Variables ¶
var Null io.ReadWriteCloser = nullStream{}
Null is an io.ReadWriteCloser.
Reads from it return 0 bytes and io.EOF. Writes and Closes succeed without doing anything.
See also io.Discard.
Functions ¶
func IsNullWriter ¶
IsNullWriter checks if a writer is known to be a writer that discards any input
Types ¶
type IOStream ¶
IOStream represents a set of input and output streams commonly associated to a process.
func FromEnv ¶
func FromEnv() IOStream
FromEnv creates a new IOStream using the environment.
The Stdin, Stdout and Stderr streams are used from the os package.
func FromNil ¶
func FromNil() IOStream
FromNil creates a new IOStream that silences all output and provides no input.
func NewIOStream ¶
NewIOStream creates a new IOStream with the provided readers and writers. If any of them are set to nil, they are set to Null.
func NonInteractive ¶
NonInteractive creates a new non-interactive writer from a single output stream.
It is roughly equivalent to NewIOStream(Writer, Writer, nil, 0)
func (IOStream) EPrintf ¶
EPrintf is like fmt.Printf but prints to io.Stderr.
func (IOStream) EPrintln ¶
EPrintln is like fmt.Println but prints to io.Stderr.
func (IOStream) NonInteractive ¶
NonInteractive creates a new IOStream with Null as standard input.
func (IOStream) Printf ¶
Printf is like fmt.Printf but prints to str.Stdout.
func (IOStream) Println ¶
Println is like fmt.Println but prints to str.Stdout.
func (IOStream) ReadLine ¶
ReadLine is like nobufio.ReadLine on the standard input
func (IOStream) ReadPassword ¶
ReadPassword is like nobufio.ReadPassword on the standard input
func (IOStream) ReadPasswordStrict ¶
ReadPasswordStrict is like nobufio.ReadPasswordStrict on the standard input
func (IOStream) StderrIsATerminal ¶
StderrIsATerminal checks if standard error is a terminal
func (IOStream) StdinIsATerminal ¶
StdinIsATerminal checks if standard input is a terminal
func (IOStream) StdoutIsATerminal ¶
StdoutIsATerminal checks if standard output is a terminal