term

Documentation

Index

• func AllowsColorOutput(w io.Writer) bool
• func IsTerminal(i interface{}) bool
• type SafeFunc
• type TTY
  • func (t TTY) IsTerminalIn() bool
  • func (t TTY) IsTerminalOut() bool
  • func (t TTY) Safe(fn SafeFunc) error

Functions

func AllowsColorOutput

func AllowsColorOutput(w io.Writer) bool

AllowsColorOutput returns true if the specified writer is a terminal and the process environment indicates color output is supported and desired.

func IsTerminal

func IsTerminal(i interface{}) bool

IsTerminal returns whether the passed object is a terminal or not

Types

type SafeFunc

type SafeFunc func() error

SafeFunc is a function to be invoked by TTY.

type TTY

type TTY struct {
	// In is a reader representing stdin. It is a required field.
	In io.Reader
	// Out is a writer representing stdout. It must be set to support terminal resizing. It is an
	// optional field.
	Out io.Writer
	// Raw is true if the terminal should be set raw.
	Raw bool
	// TryDev indicates the TTY should try to open /dev/tty if the provided input
	// is not a file descriptor.
	TryDev bool
	// Parent is an optional interrupt handler provided to this function - if provided
	// it will be invoked after the terminal state is restored. If it is not provided,
	// a signal received during the TTY will result in os.Exit(0) being invoked.
	Parent *interrupt.Handler
}

TTY helps invoke a function and preserve the state of the terminal, even if the process is terminated during execution. It also provides support for terminal resizing for remote command execution/attachment.

func (TTY) IsTerminalIn

func (t TTY) IsTerminalIn() bool

IsTerminalIn returns true if t.In is a terminal. Does not check /dev/tty even if TryDev is set.

func (TTY) IsTerminalOut

func (t TTY) IsTerminalOut() bool

IsTerminalOut returns true if t.Out is a terminal. Does not check /dev/tty even if TryDev is set.

func (TTY) Safe

func (t TTY) Safe(fn SafeFunc) error

Safe invokes the provided function and will attempt to ensure that when the function returns (or a termination signal is sent) that the terminal state is reset to the condition it was in prior to the function being invoked. If t.Raw is true the terminal will be put into raw mode prior to calling the function. If the input file descriptor is not a TTY and TryDev is true, the /dev/tty file will be opened (if available).