cwriter

Documentation

Index

• Constants
• func GetTermSize() (width, height int, err error)
• type Writer
  • func New(w io.Writer) *Writer
  • func (w *Writer) Flush() error
  • func (w *Writer) Write(b []byte) (n int, err error)

Constants

const ESC = 27

ESC is the ASCII code for escape character

Functions

func GetTermSize

func GetTermSize() (width, height int, err error)

GetTermSize returns the dimensions of the given terminal. the code is stolen from "golang.org/x/crypto/ssh/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(w io.Writer) *Writer

New returns a new Writer with defaults

func (*Writer) Flush

func (w *Writer) Flush() error

Flush flushes the underlying buffer

func (*Writer) Write

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

Write save the contents of b to its buffers. The only errors returned are ones encountered while writing to the underlying buffer.