terminal

Documentation

Index

• type Control
• type ControlFactory
• type EscapeCodes
• type Terminal

Types

type Control

type Control interface {
	ErrPasteIndicator() error
	Escape(Terminal) EscapeCodes
	GetSize(int) (int, int, error)
	MakeRaw(int) (interface{}, error)
	NewTerminal(io.ReadWriter, string) Terminal
	Restore(int, interface{}) error
	SetAutoCompleteCallback(Terminal, func(string, int, rune) (string, int, bool))
}

Control represents terminal control

type ControlFactory

type ControlFactory func() Control

ControlFactory represents a function that can create a Control

type EscapeCodes

type EscapeCodes struct {
	Black, Red, Green, Yellow, Blue, Magenta, Cyan, White []byte
	Reset                                                 []byte
}

EscapeCodes represents the escape codes used for a specific terminal

type Terminal

type Terminal interface {
	ReadLine() (string, error)
	ReadPassword(string) (string, error)
	SetBracketedPasteMode(bool)
	SetPrompt(string)
	SetSize(int, int) error
	Write([]byte) (int, error)
}

Terminal represents terminal control