tty

Documentation

Overview

Package tty implements the os part of the terminal

Index

• type TTY
  • func (t *TTY) OnResize(cbk func(rows, cols int)) error
  • func (t *TTY) RawMode() error
  • func (t *TTY) Restore() error
  • func (t *TTY) SaveTTYState() error
  • func (t *TTY) TermSize() (rows, cols int, err error)

Types

type TTY

type TTY struct {
	Fd int
	// contains filtered or unexported fields
}

TTY is a basic structure to control the terminal state

func (*TTY) OnResize

func (t *TTY) OnResize(cbk func(rows, cols int)) error

OnResize listen of the SIGWINCH event (trigger by terminal apps after the terminal changes its sizes). The callback cbk is also called the first time this function is called even if not SIGWINCH is called.

func (*TTY) RawMode

func (t *TTY) RawMode() error

RawMode sets the terminal into RawMode

func (*TTY) Restore

func (t *TTY) Restore() error

Restore returns the tty to the state save with SaveTTYState

func (*TTY) SaveTTYState

func (t *TTY) SaveTTYState() error

SaveTTYState records the current low level terminal state

func (*TTY) TermSize

func (t *TTY) TermSize() (rows, cols int, err error)

TermSize returns the terminal size