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(lineCount int) (err error)
  • func (w *Writer) GetWidth() (int, error)
  • func (w *Writer) ReadFrom(r io.Reader) (n int64, err error)
  • func (w *Writer) Write(p []byte) (n int, err error)
  • func (w *Writer) WriteString(s string) (n int, err error)

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 {
	// contains filtered or unexported fields
}

Writer is a buffered the writer that updates the terminal. The contents of writer will be flushed when Flush is called.

func New

func New(out io.Writer) *Writer

New returns a new Writer with defaults.

func (*Writer) Flush

func (w *Writer) Flush(lineCount int) (err error)

Flush flushes the underlying buffer.

func (*Writer) GetWidth

func (w *Writer) GetWidth() (int, error)

GetWidth returns width of underlying terminal.

func (*Writer) ReadFrom

func (w *Writer) ReadFrom(r io.Reader) (n int64, err error)

ReadFrom reads from the provided io.Reader and writes to the underlying buffer.

func (*Writer) Write

func (w *Writer) Write(p []byte) (n int, err error)

Write appends the contents of p to the underlying buffer.

func (*Writer) WriteString

func (w *Writer) WriteString(s string) (n int, err error)

WriteString writes string to the underlying buffer.