cwriter

Documentation

Index

• Constants
• func TermSize() (width, height int, err error)
• type Writer
  • func New(w io.Writer) *Writer
  • func (w *Writer) Flush() 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

Functions

func TermSize

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

TermSize 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) 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