cwriter

Documentation

Index

• Constants
• Variables
• type Writer
  • func New(out io.Writer) *Writer
  • func (w *Writer) Flush(lineCount int) 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)

Constants

const ESC = 27

ESC is the ASCII code for escape character

Variables

var NotATTY = errors.New("not 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) 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