terminal

Documentation

Index

• type Terminal
  • func (t *Terminal) Configure(rw io.ReadWriter, prompt []rune, width, height int, flush bool) *Terminal
  • func (t *Terminal) Cursor() *cursor.Cursor
  • func (t *Terminal) Flush() (n int, err error)
  • func (t *Terminal) HandleKey(k rune) (eol bool, err error)
  • func (t *Terminal) Line() *line.Line
  • func (t *Terminal) ReadLine() (err error)
  • func (t *Terminal) Swell() (n int, err error)

Types

type Terminal

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

Terminal contains the state and configuration of an input/output user interface device. The rw field abstracts how input/output is implemented by the host.

func (*Terminal) Configure

func (t *Terminal) Configure(
	rw io.ReadWriter, prompt []rune, width, height int, flush bool,
) *Terminal

Configure initializes the Terminal configuration.

func (*Terminal) Cursor

func (t *Terminal) Cursor() *cursor.Cursor

func (*Terminal) Flush

func (t *Terminal) Flush() (n int, err error)

Flush copies bytes from the receiver's output buffer to an output device.

func (*Terminal) HandleKey

func (t *Terminal) HandleKey(k rune) (eol bool, err error)

func (*Terminal) Line

func (t *Terminal) Line() *line.Line

func (*Terminal) ReadLine

func (t *Terminal) ReadLine() (err error)

func (*Terminal) Swell

func (t *Terminal) Swell() (n int, err error)

Swell copies bytes from an input device to the receiver's input buffer.