cwriter

Documentation

Overview

Package cwriter is a console writer abstraction for the underlying OS.

Index

• Variables
• func GetSize(fd int) (width, height int, err error)
• func IsTerminal(fd int) bool
• type Writer
  • func New(out io.Writer) *Writer
  • func (w *Writer) Flush(lines int) error
  • func (w *Writer) GetTermSize() (width, height int, err error)
  • func (w *Writer) IsTerminal() bool

Variables

var ErrNotTTY = errors.New("not a terminal")

ErrNotTTY not a TeleTYpewriter error.

Functions

func GetSize

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

GetSize returns the dimensions of the given terminal.

func IsTerminal

func IsTerminal(fd int) bool

IsTerminal returns whether the given file descriptor is a terminal.

Types

type Writer

type Writer struct {
	*bytes.Buffer
	// contains filtered or unexported fields
}

Writer is a buffered terminal writer, which moves cursor N lines up on each flush except the first one, where N is a number of lines of a previous flush.

func New

func New(out io.Writer) *Writer

New returns a new Writer with defaults.

func (*Writer) Flush

func (w *Writer) Flush(lines int) error

Flush flushes the underlying buffer. It's caller's responsibility to pass correct number of lines.

func (*Writer) GetTermSize

func (w *Writer) GetTermSize() (width, height int, err error)

GetTermSize returns WxH of underlying terminal.

func (*Writer) IsTerminal

func (w *Writer) IsTerminal() bool

IsTerminal tells whether underlying io.Writer is terminal.