term

Documentation

Index

• func GetSize(fd uintptr) (width, height int, err error)
• func IsTerminal(fd uintptr) bool
• func ReadPassword(fd uintptr) ([]byte, error)
• func Restore(fd uintptr, oldState *State) error
• func SetState(fd uintptr, state *State) error
• type File
• type State
  • func GetState(fd uintptr) (*State, error)
  • func MakeRaw(fd uintptr) (*State, error)

Functions

func GetSize

func GetSize(fd uintptr) (width, height int, err error)

GetSize returns the visible dimensions of the given terminal.

These dimensions don't include any scrollback buffer height.

func IsTerminal

func IsTerminal(fd uintptr) bool

IsTerminal returns whether the given file descriptor is a terminal.

func ReadPassword

func ReadPassword(fd uintptr) ([]byte, error)

ReadPassword reads a line of input from a terminal without local echo. This is commonly used for inputting passwords and other sensitive data. The slice returned does not include the \n.

func Restore

func Restore(fd uintptr, oldState *State) error

Restore restores the terminal connected to the given file descriptor to a previous state.

func SetState

func SetState(fd uintptr, state *State) error

SetState sets the given state of the terminal.

Types

type File

type File interface {
	io.ReadWriteCloser
	Fd() uintptr
}

File represents a file that has a file descriptor and can be read from, written to, and closed.

type State

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

State contains platform-specific state of a terminal.

func GetState

func GetState(fd uintptr) (*State, error)

GetState returns the current state of a terminal which may be useful to restore the terminal after a signal.

func MakeRaw

func MakeRaw(fd uintptr) (*State, error)

MakeRaw puts the terminal connected to the given file descriptor into raw mode and returns the previous state of the terminal so that it can be restored.