streams

Documentation

Index

• type In
  • func NewIn(in io.ReadCloser) *In
  • func (i *In) CheckTty(attachStdin, ttyMode bool) error
  • func (i *In) Close() error
  • func (s *In) FD() uintptr
  • func (s *In) IsTerminal() bool
  • func (i *In) Read(p []byte) (int, error)
  • func (s *In) RestoreTerminal()
  • func (s *In) SetIsTerminal(isTerminal bool)
  • func (i *In) SetRawTerminal() (err error)
• type Out
  • func NewOut(out io.Writer) *Out
  • func (s *Out) FD() uintptr
  • func (o *Out) GetTtySize() (height uint, width uint)
  • func (s *Out) IsTerminal() bool
  • func (s *Out) RestoreTerminal()
  • func (s *Out) SetIsTerminal(isTerminal bool)
  • func (o *Out) SetRawTerminal() (err error)
  • func (o *Out) Write(p []byte) (int, error)

Types

type In

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

In is an input stream to read user input. It implements io.ReadCloser with additional utilities, such as putting the terminal in raw mode.

func NewIn

func NewIn(in io.ReadCloser) *In

NewIn returns a new In from an io.ReadCloser.

func (*In) CheckTty

func (i *In) CheckTty(attachStdin, ttyMode bool) error

CheckTty checks if we are trying to attach to a container TTY from a non-TTY client input stream, and if so, returns an error.

func (*In) Close

func (i *In) Close() error

Close implements the io.Closer interface.

func (*In) FD

func (s *In) FD() uintptr

FD returns the file descriptor number for this stream.

func (*In) IsTerminal

func (s *In) IsTerminal() bool

IsTerminal returns true if this stream is connected to a terminal.

func (*In) Read

func (i *In) Read(p []byte) (int, error)

Read implements the io.Reader interface.

func (*In) RestoreTerminal

func (s *In) RestoreTerminal()

RestoreTerminal restores normal mode to the terminal.

func (*In) SetIsTerminal

func (s *In) SetIsTerminal(isTerminal bool)

SetIsTerminal overrides whether a terminal is connected. It is used to override this property in unit-tests, and should not be depended on for other purposes.

func (*In) SetRawTerminal

func (i *In) SetRawTerminal() (err error)

SetRawTerminal sets raw mode on the input terminal. It is a no-op if In is not a TTY, or if the "NORAW" environment variable is set to a non-empty value.

type Out

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

Out is an output stream to write normal program output. It implements an io.Writer, with additional utilities for detecting whether a terminal is connected, getting the TTY size, and putting the terminal in raw mode.

func NewOut

func NewOut(out io.Writer) *Out

NewOut returns a new Out from an io.Writer.

func (*Out) FD

func (s *Out) FD() uintptr

FD returns the file descriptor number for this stream.

func (*Out) GetTtySize

func (o *Out) GetTtySize() (height uint, width uint)

GetTtySize returns the height and width in characters of the TTY, or zero for both if no TTY is connected.

func (*Out) IsTerminal

func (s *Out) IsTerminal() bool

IsTerminal returns true if this stream is connected to a terminal.

func (*Out) RestoreTerminal

func (s *Out) RestoreTerminal()

RestoreTerminal restores normal mode to the terminal.

func (*Out) SetIsTerminal

func (s *Out) SetIsTerminal(isTerminal bool)

SetIsTerminal overrides whether a terminal is connected. It is used to override this property in unit-tests, and should not be depended on for other purposes.

func (*Out) SetRawTerminal

func (o *Out) SetRawTerminal() (err error)

SetRawTerminal puts the output of the terminal connected to the stream into raw mode.

On UNIX, this does nothing. On Windows, it disables LF -> CRLF/ translation. It is a no-op if Out is not a TTY, or if the "NORAW" environment variable is set to a non-empty value.

func (*Out) Write

func (o *Out) Write(p []byte) (int, error)